Autenticação

Endereços#

Ambiente	URL base
Homologação	`https://api-dev.clubelab.com/v1`
Produção	`https://api.clubelab.com/v1`

Somente HTTPS. Chamadas em http:// são recusadas com 403 https_required.

Chave de acesso#

Cada laboratório tem a sua chave, entregue pela equipe do Clube do Lab, no formato:

Código

clab_sk_<id>_<segredo>

A chave é exibida uma única vez. Guarde em cofre de segredos (variável de ambiente, gerenciador de segredos), nunca no código-fonte nem em log.

Cuidado

Se a chave vazar, avise a equipe do Clube do Lab. Ela é revogada na hora e uma nova é emitida.

Como enviar a chave#

A chave vai somente no header Authorization, no esquema Bearer. Chave na URL (query string) não é aceita, porque URL acaba em log de proxy.

HTTP

Authorization: Bearer clab_sk_xxxxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
Content-Type: application/json

Troca de chave#

Quando emitimos uma chave nova, a anterior continua válida por 7 dias. Dá para trocar no seu sistema sem interromper o envio. Em caso de vazamento, a anterior é revogada na hora.

Testar a conexão#

Terminal

curl https://api-dev.clubelab.com/v1/integrations/ping \
  -H "Authorization: Bearer $CLAB_KEY"

Resposta esperada:

JSON

{ "ok": true, "provider": "seu-sistema" }

401 invalid_api_key quer dizer chave ausente, errada, revogada ou expirada.