Centro do desenvolvedor

Documentação da API Once Email

Documentação pública para testes automatizados: autenticação, cotas, erros e uso seguro.

A documentação é pública. Chaves API exigem assinatura Developer ativa e são gerenciadas no painel.
Autenticação

Envie Authorization: Bearer oe_live_… em cada solicitação. A chave aparece uma vez; guarde-a em um gerenciador de segredos, nunca no navegador, logs ou Git.

Authorization: Bearer oe_live_your_key
Fluxo típico
  1. 1Crie uma caixa temporária e guarde o ID.
  2. 2Faça seu sistema de teste enviar um e-mail ao endereço.
  3. 3Consulte a lista com recuo; evite consultas vazias rápidas.
  4. 4Leia a mensagem, conclua as asserções e exclua a caixa.

Endpoints da Beta privada

POST /v1/inboxesGET /v1/inboxes/{inboxId}/messagesGET /v1/inboxes/{inboxId}/messages/{uid}GET /v1/inboxes/{inboxId}/messages/{uid}/attachments/{cid}DELETE /v1/inboxes/{inboxId}

Códigos de status

400

Solicitação inválida

401

Chave ausente ou inválida

403

Plano ou recurso negado

404

Recurso não encontrado

429

Limite de frequência ou cota mensal

5xx

Falha temporária do serviço

Disponibilidade de clientes

As ferramentas de teste em TypeScript e um cliente Python têm uma base implementada. Ainda não há pacote público instalável nem SDK para todas as linguagens.

Status da cobrança

O plano Developer usa assinatura mensal Stripe e cota mensal de API. Não há saldo recarregável. O checkout Live fica fechado até concluir os testes de pagamento e reembolso.

Uso aceitável

Use a API somente em sistemas autorizados. São proibidos spam, evasão de políticas, abuso de contas, monitoramento de terceiros e retenção prolongada de dados pessoais.

A API está sendo preparada para produção
O contrato é publicado primeiro. Chaves e chamadas reais só abrirão após validar webhooks, cotas e regressões.
Ver preços