Sua conta OneSignal inclui IDs públicos e chaves de API privadas que são essenciais para configurar seus aplicativos e acessar a API do OneSignal. Este guia explica onde encontrá-los, como gerenciá-los e melhores práticas para uso seguro.
App ID
O App ID é um identificador público único para seu projeto OneSignal, formatado como UUID v4. Ele é distinto das suas chaves de API privadas e é necessário para:
Encontre seu App ID em Settings > Keys & IDs no Painel OneSignal ou através da API View apps.
Organization ID
Seu Organization ID (Org ID) é um identificador único em formato UUID v4 que agrupa todos os aplicativos sob seu plano de cobrança. Ele é necessário para APIs relacionadas a:
Você pode encontrar seu organization_id no painel em Organizations > Your Organization ou através da API View an app.
Chaves de API
Existem dois tipos de chaves de API:
- Chaves de API do App
- Chave de API da Organização – Uma chave privada usada para configurar aplicativos e chaves de API dentro de uma Organização.
Chave de API do App
Sua chave de API do aplicativo é uma chave privada usada para a maioria das requisições da REST API relacionadas a um aplicativo específico.
-
Chaves de API do App podem ser criadas em Settings > Keys & IDs ou Criar uma Chave de API.
-
Elas só podem ser visualizadas uma vez criadas.
-
Inclua esta chave no cabeçalho
Authorization usando o esquema de autenticação key:
Authorization: key YOUR_REST_API_KEY
Trate Chaves de API do App como uma senha. Não a compartilhe, exponha no código do seu aplicativo ou armazene em repositórios públicos como GitHub.
Chave de API da Organização
Sua chave de API da organização é uma chave privada usada para gerenciar aplicativos e chaves de API de aplicativos dentro de uma Organização. Ela é necessária para requisições de API como:
Para criar uma chave de API da organização, navegue até Organizations > your org > Keys & IDs no seu Painel OneSignal.
Assim como as chaves de API do aplicativo, você pode configurar até 16 chaves de organização e incluir configuração de lista de permissão de IP.
Criar chaves de API
- Chave de API do App – Vá para Settings > Keys & IDs do seu aplicativo ou use a API Create API key.
- Chave de API da Organização – Vá para a seção Keys & IDs da sua organização.
Clique em Add Key para abrir o modal de criação.
Dê à sua chave um nome descritivo (por exemplo, “CRM Sync Service”).
Lista de permissão de IP
Opcionalmente, restrinja o uso da chave de API a endereços IP específicos habilitando a Lista de Permissão de IP.
Insira blocos CIDR separados por espaço (por exemplo, 192.0.2.0/24 192.0.2.123/32).
Requisições de IPs não permitidos serão negadas.
Visualizar chaves de API
Após clicar em Create, sua chave de API será mostrada uma vez. Salve-a com segurança.
Após clicar em Continue, a chave não será mais visível.
Gerenciamento de chaves
Após criar uma chave, você pode gerenciá-la através da interface de lista de chaves:
Editar chaves de API
Através do painel ou API Update API key:
- Atualizar o nome ou lista de permissão de IP
- Não altera o segredo—nenhuma alteração no código do aplicativo é necessária
Rotacionar chaves de API
Através do painel ou API Rotate API key:
- Substitui o segredo da chave
- Mantém o mesmo nome e configurações de IP
- Você deve atualizar seu aplicativo ou integração com a nova chave
Deletar chaves de API
Através do painel ou API Delete API key:
- Deleta a chave permanentemente
- Bloqueia qualquer acesso adicional à API usando essa chave
Migrando de chaves de API legadas
Introduzimos o gerenciamento avançado de chaves de API em 14 de novembro de 2024.
Passos de Migração
- Crie uma nova chave de API avançada (veja acima).
- Substitua a chave legada no seu código-fonte.
- Atualize as chamadas de API para usar
https://api.onesignal.com ao invés da URL antiga https://onesignal.com/api/v1/.
- Delete ou clique em “Disable Legacy Key” na chave legada na página Keys & IDs.
Desabilitando seu aplicativo
Você pode deletar suas chaves de API para impedir acesso adicional à API REST usando essa chave.
Você pode impedir que seu aplicativo envie mensagens em Configurações > Gerenciar aplicativo > Botões de desativar aplicativo. Consulte Aplicativos e organizações desativados para mais detalhes.
Desabilitar seu aplicativo não interrompe a cobrança para esse aplicativo. MAU de aplicativos desabilitados ainda contam para a cobrança e você precisará deletar o aplicativo ou movê-lo para uma Organização Gratuita para interromper a cobrança.Entre em contato com [email protected] para obter assistência.
