Quelle API choisir ?

API Synchrone

Si vous ne savez pas quelle API choisr, choisissez l'API Synchrone. Notre bonne vieille API, développée, maintenue et améliorée depuis des années vous permettra d'ajouter de nombreuses fonctionnalités dans votre logiciel.

L'API synchrone, comme son nom l'indique fonctionne de manière synchrone, ce qui signifie que tous vos messages seront traités avant de recevoir la réponse de notre API. Ainsi, vous avez toutes les informations de votre campagne contenues dans la réponse API. Mais cela signifie aussi que le traitement est plus long si vous envoyez beaucoup de SMS.

L'API synchrone est facile d'utilisation et correspondra à vos besoins dans la plupart des cas.

Voici un exemple de réponse API que vous pouvez recevoir en envoyant un SMS avec l'API Synchrone :

{
    "status": 1,
    "message": "OK",
    "ticket": "14672468",
    "cost": 2,
    "credits": 642,
    "total": 2,
    "sent": 2,
    "blacklisted": 0,
    "duplicated": 0,
    "invalid": 0,
    "npai": 0
}
                    
                    

<response>
    <status>1</status>
    <message>OK</message>
    <ticket>14672468</ticket>
    <cost>2</cost>
    <credits>642</credits>
    <total>2</total>
    <sent>2</sent>
    <blacklisted>0</blacklisted>
    <duplicated>0</duplicated>
    <invalid>0</invalid>
    <npai>0</npai>
</response>
                
                

API Asynchrone

L'API Asynchrone quant à elle traite vos messages de manière asynchrone. Cela signifie qu'elle aura toujours le même temps d'éxecution, peu importe le nombre de SMS envoyés. Cependant la réponse ne contiendra pas toutes les informations de votre campagne, pour les récupérer, il faudra utiliser la route GET /batches.

Cette API est idéale pour une intégration dans votre logiciel, dans le cas ou vous avez besoin d'un retour API immédiat même avec des grosses campagnes SMS.

Voici un exemple de réponse API que vous pouvez recevoir en envoyant un SMS avec l'API Asynchrone :

{
    "data": {
        "batch_id": "123456",
        "type": "batches"
    },
    "links": {
        "self": "https:///api/batches/123456"
    }
}
                    
                    

Compatibilité entre les API

Certaines fonctionnalités disponibles avec l'API synchrone peuvent aussi être utilisées avec l'API Asynchrone.

Par exemple :

• Lors de la création d'un webhook, les données de l'API Asynchrone seront également envoyé dessus.
• Les tokens que vous créez sur l'API Synchrone seront ceux utilisé par l'API Asynchrone pour vous identifier
• Si vous créez des senders avec l'API synchrone, vous pourrez les utiliser sur l'API Asynchrone.