Pular para o conteúdo

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ódulonenhum — responde em qualquer conta com a API habilitada
Escoposnenhum escopo específico
Operaçõessomente leitura
MétodoEndpointDescrição
GET/v1/meDescreve a chave, a conta, o plano e os limites
CampoTipoDescrição
team_iduuidIdentificador da conta a que a chave pertence
team_namestring | nullNome da conta
key_iduuidIdentificador da chave
key_namestringNome dado à chave na criação
key_last4stringÚltimos quatro caracteres da chave, para identificá-la sem expor o valor
key_prefix"live" | "test"Ambiente da chave
scopesstring[]Escopos da chave, por exemplo ["*:read", "sales:write"]
plan_codestringCódigo do plano em vigor
modulesstring[]Módulos do Monte seu Plano habilitados no contrato
rate_limits.burst_per_secondintegerTeto de requisições por segundo
rate_limits.requests_per_minute_readintegerTeto de leituras por minuto
rate_limits.requests_per_minute_writeintegerTeto de escritas por minuto
rate_limits.requests_per_day_totalintegerTeto de requisições por dia
Terminal window
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.

HTTPtypeQuando acontece
401invalid_tokenCabeçalho Authorization ausente ou chave inexistente
401token_revokedA chave foi revogada
401token_expiredA chave passou da data de expiração
403api_disabledA conta ainda não tem a API habilitada
403ip_not_allowedA chave restringe IPs e a requisição veio de fora da lista
429rate-limit-exceededLimite de requisições do plano excedido