LunaDocs

Carregando a busca...

EnglishEntrar no console
Nesta página

Referência da API

Usar com IA

Cada rota da API pública, gerada da especificação OpenAPI que a própria API serve. Cada operação diz como chamar: o escopo, os parâmetros, o corpo, as respostas e exemplos em curl, Node e Python. Para entender o motivo de uma decisão, siga o link do guia em cada operação.

Grupos#

Autenticação#

URL base: https://api.lunahia.com.br

Toda rota de integração pede uma chave de API no cabeçalho Authorization, no formato Bearer hlsn_.... As rotas públicas, que a página de cada operação marca, não pedem chave.

A chave carrega escopos. Cada operação diz o escopo que exige, e uma chave sem ele recebe 403. Sem chave, ou com uma chave inválida ou revogada, a resposta é 401. A chave aparece uma única vez, quando é criada. O passo a passo para criar e revogar chaves, com curl, está em Conta e chaves.

O envio de mensagem é assíncrono: a resposta é 202, e a Luna entrega à Meta no ritmo que ela permite. O resultado chega como evento de webhook, no seu endpoint.

Existe limite de requisições por chave de API. Ele é técnico, idêntico para todos os clientes, e a resposta 429 traz Retry-After com o tempo a esperar.

Todo erro devolve um corpo JSON com error (um código estável) e message (texto para uma pessoa ler). Decida pelo status e por error, nunca pelo texto de message. A página de erros lista os códigos.

Baixar#