Documentation de l'API
L'API de botamp est organisée autour de REST. Les urls de notre api sont orientés resources ce qui les rend prévisibles. Elle accepte des requêtes encodées en JSON et retourne des réponses sous le même format. Les verbes HTTP et codes de réponse sont standards.
Authentification
Chaque requête doit être authentifiée avec une clé valide. Le code de la réponse à toute requête non authentifiée est 401.
La clé peut être générée dans la configuration du compte sous "options avancées". Générer une clé rend invalides les clés générées précédemment. Cette clé donne à celui qui la détient les mêmes privilèges que le propriétaire du compte. Elle doit donc être gardée secrète. Au moindre soupçon qu'elle ait été divulguée, générer une nouvelle clé pour rendre l'ancienne impotente.
Utilisation
Authorization: Bearer <api_key>Abonnés
Insérer un abonné
Il est possible d'insérer un abonné via l'API. Si l'email figurant dans le corps de la requête est déjà présent sur Botamp, les informations de l'abonné seront mise à jour à la place. L'adresse email est requise et doit exister, les autres champs optionnels.
Le traitement est effectué de façon synchrone, la requête retourne le code 200 si les changements requis ont été appliqués, le code 400 avec l'erreur en corps de réponse sinon.
Exemple
POST https://www.botamp.com/api/subscribers/create_or_update
Content-Type: application/json; charset=utf-8
Authorization: Bearer <api_key>
{
"subscriber": {
"email": "[email protected]",
"name": "subscriber",
"job_title": "...",
"country": "...",
"address": "...",
"company_name": "...",
"website": "...",
"job_title": "...",
"postal_code": "...",
"birthday": "yyyy-mm-dd",
"tags": ["tag1", "tag2"]
}
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Insérer des abonnés en batch
Il est possible d'insérer une liste d'abonnés via l'API. Les adresses emails sont uniques. Si l'un des abonnés figurants dans le corps de la requête a une adresse email déjà présente sur botamp, ses informations seront mises à jour à la place. Si plusieurs abonnés dans le corps de la requête possèdent la même adresse email, seul le premier sera considéré. L'adresse email est requise et doit exister, les autres champs optionnels.
Le traitement est effectué de façon asynchrone, la requête retournant immédiatement avec le code 200. Un rapport d'envoi est envoyé par email une fois complété.
Exemple
POST https://www.botamp.com/api/subscribers/create_or_update_many
Content-Type: application/json; charset=utf-8
Authorization: Bearer <api_key>
{
"subscribers": [
{
"email": "[email protected]",
"name": "subscriber1",
"job_title": "...",
"country": "...",
"address": "...",
"company_name": "...",
"website": "...",
"job_title": "...",
"postal_code": "...",
"birthday": "yyyy-mm-dd",
"tags": ["tag1", "tag2"]
},
{
"email": "[email protected]",
"name": "subscriber2"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8