Token de Acesso à API

O Token de Acesso à API é um identificador único atribuído a um projeto específico ou a vários projetos em sua conta. Ele autentica sua conta para gerenciar seus projetos via API, incluindo modificações na conta, envio de mensagens, edição de projetos, etc.

Tipos de token de Acesso à API

O Pushwoosh oferece dois tipos diferentes de Token de Acesso à API: Servidor e Dispositivo.

Cada tipo de token é válido apenas para seu escopo de API específico. Ocorrerá um erro de autenticação se o token incorreto for usado.

Token de API de Servidor

O token de API de Servidor é usado com todos os métodos da API, exceto aqueles sob a API de Dispositivo. Ele deve ser incluído no corpo da solicitação no campo auth.

Token de API de Dispositivo

O token de API de Dispositivo é usado exclusivamente com os métodos da API de Dispositivo. Ele deve ser incluído nos cabeçalhos da solicitação HTTP usando o cabeçalho Authorization. Abaixo está um exemplo do formato correto do cabeçalho:

Authorization: Token <device_api_token>

Substitua <device_api_token> pelo valor real do seu Token de API de Dispositivo.

Criar e gerenciar tokens de Acesso à API

Você pode visualizar, criar e gerenciar seus tokens de Acesso à API na seção Acesso à API do Painel de Controle do Pushwoosh. Para acessá-la, vá para Configurações → Acesso à API. Token do Aplicativo de Demonstração Pushwoosh

Por padrão, cada conta inclui um token chamado Pushwoosh Demo App, que é configurado como um token de servidor.

Criar um novo token de Acesso à API

Para criar um novo token de Acesso à API:

Vá para a seção Acesso à API no Painel de Controle.
Clique em Gerar Novo Token.
Na janela que aparece, escolha o tipo de token:
- Servidor usado para a maioria dos métodos da API (excluindo os métodos da API de Dispositivo).
- Dispositivo usado apenas para os métodos da API de Dispositivo.
Digite um nome para o token.
Clique em Gerar para criar o token.

Gerar um Novo Token

Importante: Certifique-se de dar ao token acesso ao aplicativo correto no seu Painel de Controle do Pushwoosh. Saiba mais

O novo token aparecerá na lista de Acesso à API. A partir daí, você pode copiar seu valor para uso em solicitações da API ou gerenciar suas permissões de acesso conforme necessário.

Gerenciar um token

Para gerenciar um token de API existente, clique no menu de três pontos (⋮) ao lado da entrada do token na seção Acesso à API.

Gerenciar um token

As seguintes opções estão disponíveis:

Conceder acesso a todos os projetos

Dá ao token acesso a todos os projetos em sua conta. Isso permite que ele utilize totalmente a API em todos os projetos.

Revogar acesso de todos os projetos

Remove o acesso do token a todos os projetos em sua conta. O token não poderá mais usar a API até que o acesso seja concedido novamente.

Editar token

Abre a tela Editar Permissões do Token de API, onde você pode:

Alterar o nome do token
Copiar o valor do token
Escolher a quais projetos o token pode acessar, selecionando-os ou desmarcando-os na lista

Gerenciar um token

Depois de terminar de fazer as alterações, clique em Salvar para aplicá-las.

Excluir token

Remove permanentemente o token da sua conta.

Autorizando solicitações da API

Para autorizar solicitações da API, use o tipo correto de token de Acesso à API com base no tipo de método da API que você está chamando:

Para métodos da API de Servidor

Inclua o token no campo “auth” do corpo da solicitação:

Exemplo:

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // cole seu token de servidor aqui
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

Para métodos da API de Dispositivo

Use o token de Dispositivo. Inclua-o no cabeçalho da solicitação HTTP usando o seguinte formato:

Authorization: Token <device_api_token>

Substitua <device_api_token> pelo valor real do seu token.