Aide produit
Pour qui utilise le produit
Créer une inbox, lire un message, comprendre un quota, inviter un collègue, brancher le SSO, récupérer un second facteur perdu. Ce qui se fait dans l’application, écran par écran.
Écrit enFREN
Ouvrir l’aideDocumentation
Trois documents, et lequel répond à quoi
Chercher au mauvais endroit coûte plus de temps que lire. Cette page dit ce que contient chaque corpus, à qui il s’adresse et dans quelle langue il est écrit, pour que vous n’ouvriez qu’un onglet.
Les corpus
Ce que contient chacun
Un vit ici, deux vivent sur leur propre domaine. La frontière n’est pas cosmétique : elle suit celle du lecteur, et cette page est le seul endroit où elle est dite.
Référence de l’API
Pour qui appelle l’API
Chaque route de /v1 : ses champs, la portée de clé qu’elle exige, ses codes d’erreur, et les refus qu’aucune portée ne lève. Le document OpenAPI dont elle est tirée est vérifié par la suite de tests à chaque modification de l’API.
Écrit enEN
Ouvrir la référenceGuides d’intégration
Pour qui branche ses tests
Le chemin du premier appel : une clé, une inbox, un message, une assertion. Puis l’authentification, la forme des erreurs, l’attente qui remplace la boucle de relance, et la reprise d’une suite écrite pour Mailosaur.
Écrit enEN
CommencerPar besoin
Je veux…
La même carte, prise par la question plutôt que par le document. S’il vous manque une ligne ici, c’est une page qui manque : écrivez-nous plutôt que de chercher.
| Je veux… | C’est écrit |
|---|---|
| recevoir un message dans mes tests et lire le code qu’il contient | Guides d’intégration |
| installer un paquet dans Playwright ou Cypress plutôt qu’appeler l’API | 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 savoir ce qu’elle peut atteindre | Guides d’intégration |
| comprendre un quota atteint, ou changer la rétention d’une inbox | Aide produit |
| inviter un collègue, cloisonner un espace de travail, brancher le SSO | Aide produit |
| reprendre une suite de tests écrite pour un autre fournisseur | Guide de migration |
| savoir ce que ça coûte, et à partir de quel volume | Tarifs |
| savoir où sont mes données et ce que le DPA engage | Souveraineté et RGPD |
| savoir si le service répond en ce moment | Statut du service |
Langues
Pourquoi la partie technique n’est qu’en anglais
L’aide produit existe dans les deux langues, et pas par bonne volonté : un article qui n’existerait que dans une seule fait échouer la suite de tests. Elle s’adresse au client d’un produit vendu en France.
La référence et les guides sont en anglais seulement. Ils s’adressent à quelqu’un qui lit déjà un en-tête Authorization, et un corpus bilingue qu’on n’a pas les moyens de tenir à jour des deux côtés devient un corpus dont une moitié est fausse.
Les messages d’erreur de l’API sont en français aujourd’hui. La référence le dit plutôt que de le cacher : le contrat est le champ error.code, jamais la phrase qui l’accompagne.
Reste la seule documentation qui prouve quelque chose
Une clé, une inbox et un premier message : le plan gratuit ne demande pas de carte bancaire, et le démarrage rapide tient en cinq minutes.