---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API de instalação por push

# API de instalação por push {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 min. de leitura

A API de instalação por push fornece endpoints para registrar e cancelar o registro dos tokens que permitem que os 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 aplicativos para celular personalizados, para configurar Notificações por push, você deve registrar o dispositivo com o 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 envio, 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 {#ariaid-title2}

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

### Formato da URL {#push-POST-installation__section_x12_fqg_dmb}

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

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

### Parâmetros de solicitação compatíveis

{#push-POST-installation__entry__2}{#push-POST-installation__version-RESTAPI}

| Parâmetro | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor 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 as notificações por push serão registradas. Este parâmetro deve ser igual ao valor na coluna Nome da aplicação associada na tabela Aplicação de envio por push \[sys_push_application\]. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#push-POST-installation__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#push-POST-installation__entry__12}

| Elemento | Descrição |
|-|-|
| plataforma | Plataforma na qual a notificação por push será registrada. Este parâmetro deve ser o valor de Nome da tabela Plataforma de envio \[sys_push_platform\]. Tipo de dados: cadeia de caracteres |
| token | Token fornecido pelo fabricante do dispositivo, como a Apple, quando o aplicativo para celular é registrado para receber notificações por push. O endpoint grava o valor do token na tabela Instalação de notificação por push \[sys_push_notif_app_install\]. Tipo de dados: cadeia de caracteres |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#push-POST-installation__entry__18}{#push-POST-installation__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]

{#push-POST-installation__entry__22}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#push-POST-installation__entry__26}{#push-POST-installation__entry-200-status-code}{#push-POST-installation__entry-401-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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. |
[Tabela 6. Códigos de status]

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

{#push-POST-installation__entry__36}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[ ]

### Amostra de solicitação cURL

    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/{pushApplicationName}/removeInstallation {#ariaid-title3}

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

### Formato da URL {#push-POST-removeInstallation__section_uy3_drg_dmb}

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

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

### Parâmetros de solicitação compatíveis

{#push-POST-removeInstallation__entry__2}{#push-POST-removeInstallation__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor 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 o registro das notificações por push será cancelado. Este parâmetro deve ser igual ao valor na coluna Nome da aplicação associada na tabela Aplicação de envio por push \[sys_push_application\]. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]

{#push-POST-removeInstallation__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 8. Parâmetros de consulta]

{#push-POST-removeInstallation__entry__12}

| Elemento | Descrição |
|-|-|
| plataforma | Plataforma na qual a notificação por push será registrada. Este parâmetro deve ser o valor de Nome da tabela Plataforma de envio \[sys_push_platform\]. Tipo de dados: cadeia de caracteres |
[Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#push-POST-removeInstallation__entry__16}{#push-POST-removeInstallation__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 10. Cabeçalhos da solicitação]

{#push-POST-removeInstallation__entry__20}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#push-POST-removeInstallation__entry__24}{#push-POST-removeInstallation__entry-200-status-code}{#push-POST-removeInstallation__entry-401-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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. |
[Tabela 12. Códigos de status]

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

{#push-POST-removeInstallation__entry__34}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[ ]

### Amostra de solicitação cURL

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

    None