Trois documentations, et laquelle ouvrir
L'aide de l'application, la référence de l'API et les guides d'intégration répondent chacune à une question différente. L'aide est sur ce site, la référence et les guides sur le portail des développeurs.
Ce que contient chacune
Vous en ouvrez une selon ce que vous faites : cliquer dans l'application, écrire le code qui appelle l'API, brancher ce code sur votre suite de tests.
Aide de l'application
Si vous utilisez Facteur à l'écran. Créer une inbox, l'adresse qui reçoit les e-mails déclenchés par vos tests. Puis lire un message, comprendre un quota atteint, inviter un collègue, récupérer un second facteur perdu. Écran par écran, en français et en anglais.
Référence de l'API
Si vous appelez l'API. Chaque opération de l'API publique, avec ses champs et ses codes d'erreur. Elle est produite à partir du document OpenAPI que le service écrit lui-même, et ne peut donc pas décrire une route qu'il ne sert pas. En français et en anglais.
Guides d'intégration
Si vous branchez vos tests. Le chemin du premier appel : une clé, une inbox, un message reçu, une assertion qui passe. Puis l'authentification, la forme des erreurs, les limites, Playwright, Cypress et la reprise d'une suite écrite pour Mailosaur. En français et en anglais.
Je veux…
Si vous savez ce que vous voulez faire mais pas où c'est écrit, partez d'ici. Et si votre besoin manque à la liste, écrivez-nous : c'est une page qu'il nous reste à écrire.
| Je veux… | C'est écrit |
|---|---|
| recevoir un message dans mes tests et lire le code qu'il contient | Guides d'intégration |
| savoir où en sont les paquets pour Playwright, Cypress et Node | Intégrations |
| connaître les champs exacts d'une réponse, ou le sens d'un code d'erreur | Référence de l'API |
| créer une clé d'API et l'envoyer avec mes requêtes | Guides d'intégration |
| comprendre un quota atteint, ou la durée de conservation de mes messages | Aide de l'application |
| inviter un collègue, ou cloisonner un espace de travail | Aide de l'application |
| reprendre une suite de tests écrite pour un autre service | Migrer depuis Mailosaur |
| savoir ce que ça coûte, et à partir de quel volume | Tarifs |
| savoir où sont mes données et ce que l'accord de traitement engage | Souveraineté |
| voir un e-mail de test arriver, sans créer de compte | Essai sans compte |
Ce qui est traduit, et ce qui ne l'est pas
-
Les trois documentations existent en français et en anglais. Choisissez la vôtre en haut de page.
-
Ce que vous lisez est traduit, ce que vous tapez ne l'est jamais. Un nom de champ, un chemin comme /v1/inboxes, un code d'erreur comme CRITERIA_UNKNOWN s'écrivent en anglais dans les deux versions : c'est ce que l'API attend, et ce qu'elle renvoie.
-
La phrase qui accompagne un refus de l'API, le champ detail, est en anglais quelle que soit votre langue. Branchez vos tests sur le champ code, jamais sur cette phrase : le code ne change pas, la phrase peut être réécrite.
Lisez, ou essayez tout de suite
Une clé, une inbox et un premier message : l'offre gratuite ne demande pas de carte bancaire.