Skip to content

Testar a API Key

Request

Valida a API Key e o IP de origem sem consultar nenhum dado.

Custo: 0 créditos. Use este endpoint para conferir a integração antes de disparar consultas cobradas.

Como interpretar a resposta:

  • 200 - chave válida e IP autorizado. Além de status: OK, o corpo identifica de quem é a chave (empresa e usuário), para confirmar que a credencial é a da conta certa e não a de outro ambiente
  • 401 - API Key inválida, mal formatada ou IP fora da whitelist
  • 406 - API Key válida, porém sem acesso à API liberado na plataforma (peça a liberação ao administrador da conta)
  • 429 - limite de requisições da empresa excedido. Mesmo sem custo em créditos, este endpoint está sujeito ao rate limit
Security
ApiKeyAuth
curl -i -X GET \
  https://docs.datastone.com.br/_mock/api/apitest/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

API Key válida e IP autorizado

Bodyapplication/json
statusstring

Sempre OK

Example:"OK"
companyobject

A empresa dona da chave.

userobject

O usuário dono da chave.

Response
{
  "status": "OK"
}