Logo

Base URL

https://lip-backend-1064145932505.southamerica-east1.run.app

API Key

Cada API key pertence a um workspace e define escopos de acesso.

Onde gerar

  • Painel: Company > API & Webhooks

Como enviar

  • Header recomendado: x-api-key: lip_...
  • Alternativo: Authorization: Bearer lip_...
  • Alternativo: query string ?api_key=lip_...

Formato

  • Prefixo lip_ + 64 caracteres hexadecimais

Escopos

  • * (acesso total)
  • whatsapp:send (envio de mensagens e templates)
  • whatsapp:templates:read (listar/obter templates)
  • whatsapp:templates:write (criar/editar/excluir templates)
  • webhooks:manage (criar/editar/remover webhooks)

Exemplo de uso

Expiracao

Se a API key tiver expiracao, chamadas apos a data retornam 401.

Erros comuns

  • 401 API key nao informada ou invalida
  • 403 escopo insuficiente
  • 400 payload invalido

Resposta de erro:

Boas praticas

  • Guarde a chave em cofre/secret manager
  • Restrinja escopos ao minimo necessario
  • Revogue e gere nova chave se houver vazamento
  • Crie uma chave por integracao/sistema

API Keys (endpoints internos)

Estas rotas sao usadas pelo painel/usuarios autenticados para gerenciar chaves.

Criar API key

POST /api/api-keys

Body:

  • name (string, obrigatorio)
  • scopes (array de strings, opcional)
  • expiresAt (string ISO, opcional)

Resposta:

Listar API keys

GET /api/api-keys

Revogar API key

DELETE /api/api-keys/{id}

Última atualização

9 de fevereiro de 2026

Editar esta página no GitHub