Documentação para desenvolvedoresAPI

API Once Email

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

A documentação é pública. A criação de chaves API e as chamadas reais ainda não estão abertas ao público. O fluxo abaixo é apenas para quem já tem autorização explícita de acesso à API e credenciais válidas.
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 para testadores autorizados
  1. Prossiga somente com acesso à API explicitamente autorizado e credenciais válidas já emitidas com as permissões mínimas necessárias. Guarde-as em um mecanismo de segredos do processo; sem esse acesso, limite-se a revisar a documentação e os downloads. Crie uma caixa temporária e guarde o ID.
  2. Faça seu sistema de teste enviar um e-mail ao endereço.
  3. Consulte a lista com recuo; evite consultas vazias rápidas.
  4. Leia 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

413

Resposta ou anexo grande demais

429

Limite de frequência ou cota mensal

503

Falha temporária do serviço

Disponibilidade de clientes

Há candidatos de pré-lançamento abertos para TypeScript, Python, Java, Go, .NET, PHP e Ruby. A CI nativa passou em Linux, macOS e Windows; ainda não há versões nos registros.

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
Documentação pública e downloads preliminares não concedem acesso à API. A criação de chaves API e as chamadas reais não estão abertas ao público.
Ver SDKsVer preços

API Demo

Exemplo seguro multiplataforma

Para sistemas próprios ou autorizados; funciona com Node.js 20+ em Windows, Linux e macOS.

node demos/api/authorized-workflow.mjs
ONCE_EMAIL_API_KEY <- process secret facility
create inbox -> list messages -> finally delete inbox
Abrir demo completo

Guia completa de uso

Baixar pacote local versionado

Use somente aplicações próprias ou autorizadas. Once Email apenas recebe e-mail.

Documentação e código públicos; API controlada e downloads preliminares fora dos registros. Documentação pública e downloads preliminares não concedem acesso à API. A criação de chaves API e as chamadas reais não estão abertas ao público.

Verifique SHA256SUMS antes de extrair.

Baixar pacoteSHA256SUMS

Ponto inicial local exato

node demos/api/authorized-workflow.mjs

Do download à limpeza

  1. Confirme propriedade ou autorização; use local, test ou staging.
  2. Prossiga somente com acesso à API explicitamente autorizado e credenciais válidas já emitidas com as permissões mínimas necessárias. Guarde-as em um mecanismo de segredos do processo; sem esse acesso, limite-se a revisar a documentação e os downloads.
  3. Baixe, verifique, extraia e leia a documentação.
  4. Execute o demo com Node.js 20+ e acione um e-mail marcado.
  5. Consulte com espera limitada e leia só a correspondência única.
  6. Exclua em finally e separe falha de limpeza.

Falhas e recuperação

Separe 400/401/403/404/413/429/503, timeout, ambiguidade, extração, asserção e limpeza. Tente novamente apenas dentro do prazo.

Ver código públicoLer guia prático