Sua conta (me)
GET /v1/me descreve a chave de API que fez a chamada: a conta a que ela
pertence, os escopos que carrega, o plano em vigor, os módulos habilitados e os
limites de requisição aplicados. É a chamada mais leve da API e a forma
recomendada de conferir se uma chave está funcionando.
| Módulo | nenhum — responde em qualquer conta com a API habilitada |
| Escopos | nenhum escopo específico |
| Operações | somente leitura |
Endpoints
Seção intitulada “Endpoints”| Método | Endpoint | Descrição |
|---|---|---|
GET | /v1/me | Descreve a chave, a conta, o plano e os limites |
| Campo | Tipo | Descrição |
|---|---|---|
team_id | uuid | Identificador da conta a que a chave pertence |
team_name | string | null | Nome da conta |
key_id | uuid | Identificador da chave |
key_name | string | Nome dado à chave na criação |
key_last4 | string | Últimos quatro caracteres da chave, para identificá-la sem expor o valor |
key_prefix | "live" | "test" | Ambiente da chave |
scopes | string[] | Escopos da chave, por exemplo ["*:read", "sales:write"] |
plan_code | string | Código do plano em vigor |
modules | string[] | Módulos do Monte seu Plano habilitados no contrato |
rate_limits.burst_per_second | integer | Teto de requisições por segundo |
rate_limits.requests_per_minute_read | integer | Teto de leituras por minuto |
rate_limits.requests_per_minute_write | integer | Teto de escritas por minuto |
rate_limits.requests_per_day_total | integer | Teto de requisições por dia |
Exemplos
Seção intitulada “Exemplos”Consultar a chave
Seção intitulada “Consultar a chave”curl "$LIGGA_BASE/v1/me" \ -H "Authorization: Bearer $LIGGA_API_KEY"{ "data": { "team_id": "bca09e2f-41ab-4417-b84b-f2ff50f991ca", "team_name": "Pet Shop Aurora", "key_id": "c06d8705-f091-46e1-81bb-4a2cec656694", "key_name": "Integração ERP", "key_last4": "af0e", "key_prefix": "live", "scopes": ["*:read", "sales:write"], "plan_code": "pro", "modules": ["clientes", "vendas", "despesas", "agendamentos"], "rate_limits": { "burst_per_second": 10, "requests_per_minute_read": 300, "requests_per_minute_write": 120, "requests_per_day_total": 100000 } }, "meta": { "request_id": "req_01JZXQ8V2K5M7N9P0R1S2T3U4V" }}Os valores de rate_limits variam por plano. Os do exemplo não são um
contrato: leia sempre os da sua própria resposta.
Erros comuns
Seção intitulada “Erros comuns”| HTTP | type | Quando acontece |
|---|---|---|
| 401 | invalid_token | Cabeçalho Authorization ausente ou chave inexistente |
| 401 | token_revoked | A chave foi revogada |
| 401 | token_expired | A chave passou da data de expiração |
| 403 | api_disabled | A conta ainda não tem a API habilitada |
| 403 | ip_not_allowed | A chave restringe IPs e a requisição veio de fora da lista |
| 429 | rate-limit-exceeded | Limite de requisições do plano excedido |
Veja também
Seção intitulada “Veja também”- Início rápido — a primeira chamada, passo a passo
- Autenticação — formato das chaves e escopos
- Módulos e escopos — o que
modulessignifica - Limites de requisições — o que
rate_limitscontrola