Welche API wählen?

We have two APIs: the synchronous API and the asynchronous API. But what are their uses?

Synchrone API

Wenn Sie nicht wissen, welche API Sie wählen sollen, wählen Sie die API Synchronous. Unsere gute alte API, die im Laufe der Jahre entwickelt, gepflegt und verbessert wurde, ermöglicht es Ihnen, Ihrer Software viele Funktionen hinzuzufügen.

Die synchrone API arbeitet, wie der Name schon sagt, synchron, was bedeutet, dass alle Ihre Nachrichten verarbeitet werden, bevor Sie die Antwort von unserer API erhalten. Das bedeutet, dass alle Informationen über Ihre Kampagne in der API-Antwort enthalten sind. Das bedeutet aber auch, dass die Verarbeitung länger dauert, wenn Sie viele SMS-Nachrichten versenden.

Die synchrone API ist einfach zu verwenden und wird Ihren Anforderungen in den meisten Fällen gerecht.

Hier sehen Sie ein Beispiel für die API-Antwort, die Sie erhalten können, wenn Sie eine SMS mit der Synchronous API senden: 


{
    "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>

Asynchrone API

Die API Asynchronous hingegen verarbeitet Ihre Nachrichten asynchron. Das bedeutet, dass sie immer die gleiche Ausführungszeit hat, unabhängig davon, wie viele SMS-Nachrichten gesendet werden. Die Antwort enthält jedoch nicht alle Informationen zu Ihrer Kampagne; um sie abzurufen, müssen Sie den Endpunkt GET /batches verwenden.

Diese API ist ideal für die Integration in Ihre Software, wenn Sie auch bei großen SMS-Kampagnen sofortiges API-Feedback benötigen.

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"
    }
}

API-Kompatibilität

Einige Funktionen, die mit der synchronen API verfügbar sind, können auch mit der asynchronen API verwendet werden.

Par exemple :

  • Wenn ein Webhook erstellt wird, werden die Daten von der asynchronen API auch an diesen gesendet.
  • Die Token, die Sie in der synchronen API erstellen, werden von der asynchronen API verwendet, um Sie zu identifizieren.
  • Wenn Sie Absender mit der synchronen API erstellen, können Sie sie mit der asynchronen API verwenden.