API de instalação por push

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 4 min. de leitura

    • . Instalação por push A API fornece endpoints para registrar e cancelar o registro dos tokens que permitem que dispositivos móveis recebam notificações por push de uma aplicação.

    Uma notificação por push é uma mensagem de texto que aparece no dispositivo móvel de um usuário para alertá-lo sobre algo importante ou para solicitar que ele execute uma ação.

    Ao criar aplicações móveis personalizadas, para configurar as notificações por push, você deve registrar o dispositivo no serviço do fabricante. O serviço deve saber o endereço do dispositivo de um usuário para que possa enviar notificações corretamente para esse dispositivo usando tokens de push. O dispositivo também precisa ser capaz de receber as notificações e agir sobre elas. Para obter instruções sobre como registrar um dispositivo e obter um token de push, consulte a documentação do desenvolvedor de sistemas operacionais do dispositivo. Por exemplo, para dispositivos Apple, consulte https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns.

    Instalação por push - POST /now/push/pushApplicationName/installation

    Adiciona ou atualiza tokens que permitem que os dispositivos recebam notificações por push da aplicação especificada.

    Formato de URL

    URL com controle de versão: /api/now//push//pushApplicationName/installation

    URL padrão: /api/now/push/pushApplicationName/installation

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Parâmetro Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres
    PushApplicationName Nome da aplicação para a qual registrar as notificações por push. Este parâmetro deve ser igual ao valor na coluna Nome da aplicação associada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Aplicação por push [sys_push_application]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Elemento Descrição
    plataforma Plataforma na qual registrar a notificação por push.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Nome da tabela Plataforma por push [sys_push_platform].
    token Token fornecido pelo fabricante do dispositivo, como a Apple, quando o aplicativo para celular é registrado para receber notificações por push.

    Tipo de dados: Cadeia de caracteres

    Armazenado em: Instalação de notificação por push [sys_push_notif_app_install]

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro Interno do servidor. Ocorreu um erro de lógica no código do lado do servidor.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    Nenhum(a)

    Solicitação de cURL de amostra

    curl -X POST \
  https://instance.servicenow.com/api/now/push/ServiceNowPushApp/installation \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{"platform":"Apple","token":"544836d77ac2e551bbf78204630509a7d494fc87f52e85da52e5b5d42910e2cf"}' \
    None

    Instalação por push - POST /now/push//removeInstallation

    Desativa os tokens que permitem que dispositivos móveis recebam notificações por push da aplicação especificada.

    Formato de URL

    URL com controle de versão: /api/now//push//pushApplicationName/removeInstallation

    URL padrão: /api/now/push/pushApplicationName/removeInstallation

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres
    PushApplicationName Nome da aplicação para a qual cancelar o registro das notificações por push.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Nome da aplicação associada na tabela Aplicação de push [sys_push_application].
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
    Elemento Descrição
    plataforma Plataforma na qual registrar a notificação por push.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Nome da tabela Plataforma por push [sys_push_platform].

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro Interno do servidor. Ocorreu um erro de lógica no código do lado do servidor.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    Nenhum(a)

    Solicitação de cURL de amostra

    curl -X POST \
  https://instance.servicenow.com/api/now/push/ServiceNowPushApp/removeInstallation \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{"platform":"Apple"}' \
    None