Pular para o conteúdo principal

Chave de API

A chave de API identifica a conta de desenvolvedor que faz uma solicitação às APIs da GVR.

Gerenciar sua chave​

Crie, consulte, troque ou exclua sua chave de API no aplicativo da GVR. Esta documentação explica como usá-la depois que estiver disponível na sua conta.

Usar uma chave​

Envie sua chave aos endpoints para desenvolvedores no cabeçalho apiKey da solicitação:

apiKey: YOUR_API_KEY

Em solicitações JSON, inclua também o cabeçalho de tipo de conteúdo correspondente:

Content-Type: application/json
apiKey: YOUR_API_KEY

Para enviar arquivos, inclua a chave na solicitação de formulário multipart.

Ciclo de vida da chave​

Se uma chave for trocada ou excluída no aplicativo da GVR, as solicitações que usarem a chave antiga falharão com:

{
  "error": "Invalid API key"
}

Notas de segurança​

  • Armazene as chaves em variáveis de ambiente no servidor.
  • Não inclua chaves em um repositório.
  • Não exponha chaves em pacotes públicos do frontend.
  • Se uma chave for compartilhada por engano, troque-a no aplicativo da GVR.