O Organization ID (Org ID) é um UUID (v4) que agrupa todos os aplicativos sob seu plano de cobrança.Você precisa dele para APIs de nível organizacional como:
Existem dois tipos de chaves de API. Ambas autenticam requisições da REST API e devem ser mantidas em segredo. Escolha aquela que corresponde ao que você quer fazer:
Use uma Chave de API do App para qualquer requisição da REST API restrita a um único aplicativo: envio de mensagens; criação ou atualização de usuários; ou leitura do histórico de mensagens.O painel nunca exibe os valores de chaves de API existentes. A string na coluna Key ID é apenas um identificador interno, não a chave. Para obter novamente um segredo funcional, siga os passos abaixo para criar uma nova chave de API ou rotacione uma chave existente. A rotação gera um novo valor mantendo o mesmo Key ID, nome e lista de permissão de IP, e o valor antigo para de funcionar imediatamente.
O painel mostra o Key ID, não o valor da chave de API. O valor real (começando com os_v2_app_) é exibido apenas uma vez, quando a chave é criada ou rotacionada.
Criar uma Chave de API do AppSiga estes passos para criar uma Chave de API do App no painel ou use a API Create API key.
1
Acesse Settings > Keys & IDs do app
No painel OneSignal, selecione seu aplicativo e vá para Settings > Keys & IDs.
2
Clique em Add Key
Insira um nome descritivo (por exemplo, Backend service). Opcionalmente, adicione uma lista de permissão de IP para que a chave funcione apenas a partir de servidores aprovados.
3
Clique em Create e copie o valor da chave imediatamente
O valor começa com os_v2_app_ e é exibido apenas uma vez. Armazene-o em um gerenciador de segredos ou variável de ambiente do backend imediatamente.
Valor da chave de API gerada, exibido apenas uma vez
Trate as Chaves de API do App como senhas:
Nunca as exponha no código do cliente mobile ou web.
Nunca as envie para repositórios públicos (como GitHub).
Armazene-as em um backend seguro ou gerenciador de segredos.
Criar uma Chave de API da Organização:Chaves de API da Organização são exclusivas do painel. Não há endpoint de API para criá-las.
1
Acesse Keys & IDs da organização
No painel OneSignal, vá para Organizations > Sua organização > Keys & IDs.
2
Clique em Add Key e dê um nome
Insira um nome descritivo (por exemplo, App provisioning). Opcionalmente, adicione uma lista de permissão de IP.
3
Clique em Create e copie o valor da chave imediatamente
O valor começa com os_v2_app_ e é exibido apenas uma vez. Armazene-o com segurança imediatamente.
Página Keys & IDs da organização onde as Chaves de API da Organização são criadas
As Chaves de API da Organização concedem acesso a todos os aplicativos da sua organização. Trate-as com cuidado extra e compartilhe-as apenas com serviços que realmente precisam de acesso em nível organizacional.
A lista de permissão de IP é opcional, mas fortemente recomendada. Ela restringe o uso da chave de API a endereços IP específicos, de modo que uma chave vazada não possa ser usada de outro lugar.
Insira blocos CIDR separados por espaço (exemplo: 192.0.2.0/24 192.0.2.123/32).
Requisições de IPs não permitidos são negadas.
Use a lista de permissão de IP para:
Serviços de backend com IPs estáticos.
Ambientes de produção de alta segurança.
Criando uma chave de API com lista de permissão de IP habilitada
Depois de criar uma chave, você pode editá-la, rotacioná-la ou deletá-la na lista de chaves em Settings > Keys & IDs. Chaves de API do App também suportam essas operações via REST API. Chaves de API da Organização são exclusivas do painel.
Atualize o nome ou a lista de permissão de IP sem alterar o valor secreto. Nenhuma alteração na integração é necessária.Use o painel, ou a API Update API key (apenas Chaves de API do App).
A rotação gera um novo segredo mantendo o mesmo Key ID, nome e lista de permissão de IP. O segredo antigo para de funcionar imediatamente.Rotacione uma chave quando:
A chave foi exposta.
Um membro da equipe com acesso saiu.
Uma rotação de segurança de rotina está agendada.
Você perdeu o valor original da chave e precisa de um segredo funcional.
Após rotacionar uma chave, atualize todos os serviços que usavam o valor antigo. Requisições com a chave antiga falham imediatamente.
Use o painel, ou a API Rotate API key (apenas Chaves de API do App).
A exclusão remove a chave permanentemente e bloqueia imediatamente o acesso à API que a utilizava. Use a exclusão quando uma chave não for mais necessária.Use o painel, ou a API Delete API key (apenas Chaves de API do App).
O OneSignal introduziu as Chaves de API do App e da Organização (com nomes, rotação e lista de permissão de IP) em novembro de 2024. A chave User Auth legada e a chave REST API original ainda são aceitas, mas a interface de gerenciamento delas foi removida e novas chaves não podem ser criadas.
Para revogar uma chave imediatamente, rotacione ou delete em Settings > Keys & IDs. Requisições que usam o valor antigo falham imediatamente.Para parar o envio de mensagens ou pausar um aplicativo completamente, consulte Aplicativos e organizações desativados.
Os valores das chaves de API começam com os_v2_app_ e são exibidos apenas uma vez, imediatamente após a criação ou rotação da chave. A coluna Key ID no painel é um identificador interno, não a chave de API, e retorna 401 Unauthorized se usada para autenticação. Se você não salvou o valor da sua chave, rotacione a chave para gerar um novo. Consulte Chave de API do App ou Chave de API da Organização para ver o fluxo completo.
Não. O OneSignal não exibe mais Chaves de API do App legadas. Se você não conseguir encontrar o valor no seu código, gere uma nova Chave de API do App e atualize suas integrações.
Rotacione a chave imediatamente. A rotação invalida o valor antigo e emite um novo mantendo o mesmo Key ID, nome e lista de permissão de IP. Em seguida, atualize todos os serviços que usam a chave. Revise seus logs de auditoria em busca de atividade inesperada na API.
