Wozu die API nötig ist

API (Application Programming Interface) — das ist eine Funktionalität für die Interaktion zwischen verschiedenen Programmen. Für den Menschen gibt es gesonderte Schnittstellen, zum Beispiel eine Website. Die API wird für verschiedene Integrationen benötigt. Sender Solutions verfügt über eine API, die mithilfe von HTTP-Anfragen im JSON-Format funktioniert. Der Zugang zur API wird für alle Tarifpläne des Projekts gewährt, einschließlich des kostenlosen Tarifplans. Sie können die API von Sender Solutions für eine umfassendere und flexiblere Integration nutzen. Das vorgesehene Nutzungsformat der API — von Ihrer Website aus auf Basis von Triggern. Zum Beispiel, wenn auf Ihrer Website ein Abonnent erstellt wird, führt die Website eine API-Anfrage aus, und ein Abonnent mit denselben Daten wird in Sender Solutions erstellt.

Beginn der Nutzung der API

1. Um die API zu nutzen, müssen Sie ein Projekt im persönlichen Konto von Sender Solutions erstellen.
2. Erstellen Sie anschließend auf der Einstellungsseite des Projekts einen API-Schlüssel. Das ist ein eindeutiger Zugangsschlüssel zur API auf Ebene dieses Projekts. Bewahren Sie ihn geheim. Falls der Verdacht besteht, dass der Schlüssel kompromittiert wurde, beginnen Sie so schnell wie möglich, einen neuen Schlüssel zu verwenden, und deaktivieren oder löschen Sie den kompromittierten Schlüssel.
3. Für ein Projekt können mehrere API-Schlüssel erstellt werden — sie sind alle gleichwertig. Das kann nützlich sein, wenn Sie mehrere verschiedene Anwendungen haben, die API-Anfragen ausführen.
4. Der API-Schlüssel muss im HTTP-Header Authorization übergeben werden.
5. Übergeben Sie den Anfragetext im Format JSON und geben Sie im Header Content-Type den Wert application/json an.
6. Orientieren Sie sich am HTTP-Status der Antwort. Wenn der Code 200 ist — ist alles erfolgreich verlaufen. Wenn der Code 500 ist — ist ein Fehler aufgetreten.
7. Die Antwort der API wird im Allgemeinen im Format JSON zurückgegeben. Auf der Root-Ebene ist der Schlüssel "success" mit den möglichen Werten true / false vorhanden.
   Beispiel einer erfolgreichen Antwort:
   {
    "success": true
}
   
   Beispiel einer Antwort mit Fehler:
   {
    "error": "Some error description",
    "success": false
}
   Im Text einer erfolgreichen Antwort können je nach konkreter Anfrage zusätzliche Daten enthalten sein.
8. Für die Arbeit mit der API ist keine Unterstützung von Cookies oder Sessions erforderlich.

Nützliche Ressourcen

Composer-Paket für die Arbeit mit der API in PHP: sender-solutions/php-sdk und dasselbe Paket auf GitHub: Sender-Solutions/php-sdk

Postman Anfragensammlung für die API verfügbar unter dem Link