Token de acesso da API

O Token de acesso da API é um identificador exclusivo 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 de conta, envio de mensagens, edição de projetos, etc.

Tipos de Token de acesso da API

A Pushwoosh fornece dois tipos diferentes de Tokens de acesso da API: Server (Servidor) e Device (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 Server

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

Token de API Device

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

Authorization: Token <device_api_token>

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

Criar e gerenciar Tokens de acesso da API

Você pode visualizar, criar e gerenciar seus tokens de acesso da API na seção API Access do Painel de Controle da Pushwoosh. Para acessá-la, vá para Settings → API Access. Token do Pushwoosh Demo App

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 da API

Para criar um novo Token de acesso da API:

Vá para a seção API Access no Painel de Controle.
Clique em Generate New Token.
Na janela que aparece, escolha o tipo de token:
- Server usado para a maioria dos métodos de API (excluindo métodos da Device API).
- Device usado apenas para métodos da Device API.
Insira um nome para o token.
Clique em Generate para criar o token.

Gerar um Novo Token

Importante: Certifique-se de dar ao token acesso ao aplicativo correto no seu Painel de Controle da 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 de 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 API Access.

Gerenciar um token

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

Grant access to all projects

Concede ao token acesso a todos os projetos em sua conta. Isso permite que ele use totalmente a API em todos os projetos.

Revoke access from all projects

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.

Edit token

Abre a tela Edit API Token Permissions, onde você pode:

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

Gerenciar um token

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

Delete token

Remove permanentemente o token da sua conta.

Autorizando solicitações de API

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

Para métodos da API Server

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 Device

Use o Device token. 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.