API
Introduction
Nos API vous permettent de gérer votre compte Tipimail à partir de votre application, site internet ou infrastructure. Vous pouvez aussi bien récupérer vos données, envoyer des emails ou paramètrer votre compte Tipimail sans vous connecter à l'interface de Tipimail.
Les API de Tipimail ont été développés avec les standarts HTTP ainsi que la terminologie RESTful :
- Utilisation des ressources avec leurs URL dédiées
- Utilisation des verbes HTTP (GET, POST, PUT, DELETE) et de leurs code de retour
- Toutes les données sont retournées au format JSON
Pour vous aider à utiliser nos API, nous avons publié des librairies pour les langages de programmation les plus populaires. Vous pouvez les utiliser, les modifier selon vos besoins ou bien effectuer directement des appels en CURL.
Pour chaque appel, vous pourrez trouver des exemples de code concernant les paramètres à passer et ceux retournés.
Notre Collection Postman
Téléchargez notre Collection Postman en cliquant içi
URL de base
Tous les appels à notre API doivent commencer par l'URL suivante:
https://api.tipimail.com/v1
Authentification
Chaque appel API requière une authentification. Vous devez passer vos identifiants dans l'en-tête de la requête. Vous pouvez retrouver vos identifiants sur l'interface de Tipimail, section SMTP et API. Ce sont les mêmes identifiants que ceux pour les envois par SMTP.
- X-Tipimail-ApiUser: nom d'utilisateur
- X-Tipimail-ApiKey: mot de passe
Format de date
Toutes les dates soumises en paramètres d'entrée ou de sorties sont au format timestamp. Ce format est supporté nativement par la plupart des langages de programmation
Code d'erreur
Tipimail retourne les codes d'erreur sandard
| Code | Description |
|---|---|
| 2xx | Requête réalisé correctement |
| 4xx | Problème avec la requête soumise du coté client |
| 401 | Non autorisé - Les identifiants API ne sont pas valides |
| 500 | Error du coté serveur |
| 5xx | Problème avec la requête soumise du coté serveur |