Essayer dans la documentation
Lisez la description d’un appel, puis lancez-le.

Chaque page de documentation d’une opération de l’API a un panneau Essayer. Remplissez les paramètres et le corps, envoyez, et la vraie réponse s’affiche à côté.

En bref

Qu’est-ce qu’un espace d’essai d’API ?

Un formulaire dans la documentation d’une API qui envoie de vraies requêtes, pour voir ce que renvoie un appel avant d’écrire du code pour lui. Ici, il se trouve sur la page qui documente l’appel, et chaque réponse est accompagnée de la commande cURL qui fait la même chose.

Comment ça marche

Une clé limitée à cet appel

Connecté en tant que propriétaire de l’espace de travail, vous pouvez créer une clé temporaire pour la page. Elle a exactement les permissions dont cet appel a besoin, fonctionne une heure et demande d’abord votre code de vérification.

Ou apportez votre propre clé

Une clé que vous collez n’est gardée que dans la mémoire de la page, jamais enregistrée, et oubliée après une heure sans utilisation. Vérifier ma clé montre ce qu’elle peut faire.

Un envoi depuis la documentation est un vrai envoi

Une requête qui envoie du courrier ou supprime quelque chose demande un second clic dans les cinq secondes, parce qu’elle est réelle.

Ce que vous obtenez

Déjà dans le produit

Le cURL correspondant

La vraie réponse revient avec la commande cURL qui fait la même chose.

Toujours la clé la plus récente

Une nouvelle clé temporaire remplace la dernière créée de cette façon.

Les boîtes temporaires aussi

Les appels de boîte de réception temporaire fonctionnent avec un jeton de boîte de réception au lieu d’une clé.

Bonnes pratiques

En tirer le meilleur parti

  1. 01

    Laissez la page créer la clé

    Une clé temporaire a exactement les permissions dont l’appel de cette page a besoin, et elle cesse de fonctionner après une heure.

  2. 02

    Vérifiez d’abord une clé collée

    Avant d’envoyer avec votre propre clé, appuyez sur Vérifier ma clé pour voir ce qu’elle peut faire.

  3. 03

    Envoyez d’abord à vous-même

    Un envoi depuis la documentation est un vrai envoi, alors mettez l’une de vos propres adresses dans le champ À pendant vos essais.

Questions

On nous demande souvent

Pour aller plus loin

Fonctionne bien avec

API REST

Une API HTTP documentée, avec des clés à émettre, restreindre et révoquer.

Clés API

Une clé par tâche, limitée aux droits et aux expéditeurs dont elle a besoin, avec chaque appel journalisé.

Commencer

Votre domaine,
votre courrier.

Pointez un domaine vers OpenEmail et lisez son courrier dans une boîte mail pensée pour lui. Le forfait gratuit couvre un domaine.