Experimente na documentação
Leia sobre uma chamada e depois faça-a.

Cada página da documentação de uma operação da API tem um painel Experimente. Preencha os parâmetros e o corpo, envie, e a resposta real aparece ao lado.

Em resumo

O que é um playground de API?

Um formulário dentro da documentação de uma API que envia pedidos reais, para que veja o que uma chamada devolve antes de escrever código para ela. Aqui fica na página que documenta a chamada, e cada resposta vem com o comando cURL que faz o mesmo.

Como funciona

Uma chave limitada a esta chamada

Com sessão iniciada como proprietário do espaço de trabalho, pode criar uma chave temporária para a página. Tem exatamente as permissões de que essa chamada precisa, funciona durante uma hora e pede primeiro o seu código de verificação.

Ou use a sua própria chave

Uma chave que cole fica apenas na memória da página, nunca é gravada e é esquecida após uma hora sem uso. Verificar a minha chave mostra o que ela pode fazer.

Um envio a partir da documentação é um envio

Um pedido que envia correio ou elimina algo precisa de um segundo clique em cinco segundos, porque é real.

O que recebe

Já no produto

O cURL correspondente

A resposta real vem com o comando cURL que faz o mesmo.

Sempre a chave mais recente

Uma nova chave temporária substitui a última criada desta forma.

Também caixas de entrada temporárias

As chamadas das caixas de entrada temporárias funcionam com um token de caixa de entrada em vez de uma chave.

Boas práticas

Tirar o máximo partido

  1. 01

    Deixe a página criar a chave

    Uma chave temporária tem exatamente as permissões de que a chamada dessa página precisa, e deixa de funcionar ao fim de uma hora.

  2. 02

    Verifique primeiro uma chave colada

    Antes de enviar com uma chave sua, prima Verificar a minha chave para ver o que ela pode fazer.

  3. 03

    Envie primeiro para si

    Um envio a partir da documentação é um envio real, por isso ponha um dos seus próprios endereços no campo Para enquanto experimenta.

Perguntas

O que mais nos perguntam

Continue a explorar

Combina bem com

REST API

Uma API HTTP documentada, com chaves que se emitem, se limitam e se revogam.

Chaves API

Uma chave por tarefa, limitada às permissões e remetentes de que precisa, com cada chamada registada.

Começar

O seu domínio,
o seu correio.

Aponte um domínio para o OpenEmail e leia o correio dele numa caixa de correio construída à volta dele. O plano gratuito inclui um domínio.