API · 01

Autenticar uma integração

Cada ligação pertence a um restaurante. Use a chave e o segredo emitidos no painel; ambos são necessários em cada pedido e o segredo só é exibido uma vez.

  1. O proprietário/gestor geral abre API & Integrações.
  2. Cria uma ligação, atribui um nome e seleciona o fornecedor.
  3. Copia a chave e o segredo para o cofre de segredos do integrador.
  4. Envia os cabeçalhos abaixo em chamadas HTTPS.
GET /api/integrations/v1/restaurants/{restaurantId}/catalog
X-NGola-Integration-Key: ngb_int_…
X-NGola-Integration-Secret: ngb_sec_…
Accept: application/json

Regras importantes

  • Uma credencial só dá acesso ao restaurante a que pertence.
  • Use HTTPS; nunca envie segredo em query string, browser ou repositório.
  • Rode ou revogue a credencial quando trocar fornecedor ou suspeitar de exposição.
  • O dashboard guarda apenas hashes das credenciais.