Autenticação

Onde obter uma chave

Crie e administre suas chaves de API em platform.usecroma.com. Faça login, abra sua organização e gere uma chave na seção de chaves de API. A chave completa é exibida uma única vez ao ser criada, então copie-a para um lugar seguro antes de sair da página.

Crie uma chave de API

Abra a plataforma da Croma para gerar e administrar as chaves da sua organização.

Esquema bearer

Envie sua chave no cabeçalho Authorization usando o esquema Bearer:

Authorization: Bearer croma_live_xxxxxxxxxxxxxxxxxxxx

As chaves pertencem a uma organização

Cada chave que o console emite pertence a uma organização, então o uso, os limites de taxa e o faturamento ficam atribuídos à organização, e não a quem tenha criado a chave. Uma chave sem organização por trás recebe 401:

{
  "error": {
    "type": "authentication_error",
    "code": "personal_api_key_not_allowed",
    "message": "Personal API keys are not allowed. Use an organization key."
  }
}

Formato da chave

As chaves são emitidas com a marca croma_<env>_…. Por exemplo, croma_live_… em produção e croma_test_… nos demais ambientes. O prefixo de ambiente indica de relance a qual implantação uma chave aponta; nunca use uma chave test contra dados de produção nem vice-versa.

Uma chave concede acesso completo à API da sua organização. Guarde-a como um segredo (variável de ambiente ou gerenciador de segredos), nunca a inclua no controle de versões e faça a rotação se ela for exposta.

Falha de autenticação

Toda falha de autenticação retorna um 401 com um envelope authentication_error. O campo code indica o que deu errado:

Código	O que significa	Como resolver
`invalid_api_key`	O cabeçalho `Authorization` está ausente ou malformado, ou a chave foi revogada ou expirou.	Envie uma chave válida como `Authorization: Bearer <key>`, ou emita uma nova.
`personal_api_key_not_allowed`	A chave não tem uma organização por trás.	Use uma chave emitida em platform.usecroma.com.

Próximo: Limites de taxa

Como as cotas são agrupadas e como são expostas em cada resposta.

Primeiros passos

Tipos de solicitação

Monitores

Países

Onde obter uma chave

Crie uma chave de API

Esquema bearer

As chaves pertencem a uma organização

Formato da chave

Falha de autenticação

Próximo: Limites de taxa

​Onde obter uma chave

Crie uma chave de API

​Esquema bearer

​As chaves pertencem a uma organização

​Formato da chave

​Falha de autenticação

Próximo: Limites de taxa

Onde obter uma chave

Esquema bearer

As chaves pertencem a uma organização

Formato da chave

Falha de autenticação