À quoi sert l'API

API (Application Programming Interface) — c'est une fonctionnalité pour l'interaction entre différents programmes. Pour les personnes, il existe des interfaces distinctes, par exemple un site. L'API sert à diverses intégrations. Sender Solutions dispose d'une API qui fonctionne à l'aide de requêtes HTTP au format JSON. L'accès à l'API est fourni pour tous les plans tarifaires du projet, y compris le plan tarifaire gratuit. Vous pouvez utiliser l'API de Sender Solutions pour une intégration plus complète et plus flexible. Le format prévu d'utilisation de l'API — depuis votre site sur la base de déclencheurs. Par exemple, lorsqu'un abonné est créé sur votre site, le site exécute une requête API, et un abonné avec les mêmes données est créé dans Sender Solutions.

Début de l'utilisation de l'API

1. Pour utiliser l'API, vous devez créer un projet dans le Compte personnel de Sender Solutions.
2. Ensuite, sur la page des paramètres du projet, créez une clé API. C'est une clé d'accès unique à l'API au niveau de ce projet. Conservez-la secrète. S'il y a un soupçon que la clé a été compromise, commencez à utiliser une nouvelle clé le plus rapidement possible, et désactivez ou supprimez la clé compromise.
3. Pour un même projet, on peut créer plusieurs clés API — elles sont toutes équivalentes. Cela peut être utile si vous avez plusieurs applications différentes qui exécuteront des requêtes API.
4. La clé API doit être transmise dans l'en-tête HTTP Authorization.
5. Transmettez le corps de la requête au format JSON, et dans l'en-tête Content-Type, indiquez la valeur application/json.
6. Orientez-vous sur le statut HTTP de la réponse. Si le code est 200 — tout s'est bien passé. Si le code est 500 — une erreur s'est produite.
7. La réponse de l'API est en général renvoyée au format JSON. Au niveau racine, la clé "success" est présente avec les valeurs possibles true / false.
   Exemple de réponse réussie :
   {
    "success": true
}
   
   Exemple de réponse avec erreur :
   {
    "error": "Some error description",
    "success": false
}
   Dans le corps d'une réponse réussie, il peut y avoir des données supplémentaires selon la requête précise.
8. Pour travailler avec l'API, le support des cookies ou des sessions n'est pas nécessaire.

Ressources utiles

Composer paquet pour travailler avec l'API en php : sender-solutions/php-sdk et le même paquet sur github : Sender-Solutions/php-sdk

Postman la collection de requêtes vers l'API est disponible au lien