API für Partner

v1.0

Allgemeine Beschreibung


Die API ist für aktuelle und potenzielle Onlinesim-Partner gedacht. Sie ermöglicht es Ihnen, Ihre Nummern zu monetarisieren, indem Sie sie unseren Kunden für den Empfang von SMS von verschiedenen Diensten und Anwendungen zur Verfügung stellen.

Derzeit sind zwei Versionen der API implementiert:

  • v1 eignet sich für Partner, die bereits über eine eigene Logik für die Arbeit mit Nummern verfügen. In diesem Schema fragt unser Server bei Ihrem Server Informationen über verfügbare Nummern ab und fordert, wenn eine geeignete Nummer gefunden wird, diese für den SMS-Empfang an.
  • v2 hat ein umgekehrtes Schema: Die Hauptlogik der Vorgänge liegt auf unserer Seite. Sie senden uns regelmäßig eine Liste Ihrer Nummern und leiten eingehende SMS an uns weiter, während die Nummern sofort für Kundenbestellungen verfügbar sind.

v1 API

Unser Server sendet jede Anfrage als HTTP POST mit einem JSON-Body (UTF-8) an die von Ihnen angegebene URL; der Methodenname steht im Feld action und Ihr Partnerschlüssel im Feld key. Ihre Antwort wird aus ihrem JSON-Body gelesen; ihr HTTP-Status wird nicht verwendet.

REQUESTRESPONSEYourserverOnlinesimserverGET_SERVICES(every 2 minutes)GET_NUMBER(creating an operation)PUSH_SMS(sending an SMS)FINISH_ACTIVATION(closing an operation)

Anforderungen für v1:

  1. Antworten sind JSON in UTF-8
  2. Die in der Antwort von GET_SERVICES verwendeten Länder- und Dienstnamen müssen mit den entsprechenden Listen der Länder und Dienste übereinstimmen
  3. Eine Nummer sollte jeweils nur für einen Vorgang verwendet werden: Ihr Server kann dieselbe Nummer für einen anderen Dienst erst ausgeben, nachdem der vorherige Vorgang abgeschlossen ist
  4. Webhook PUSH_SMS: Ihr Server muss SMS, die von Nummern mit aktiven Vorgängen empfangen werden, automatisch an den Onlinesim-Server weiterleiten
  5. Die Filterung kann entweder auf unserer Seite oder auf Ihrer Seite durchgeführt werden. Teilen Sie uns vor der Integration mit, welche Option Sie bevorzugen
  6. Beantworten Sie GET_NUMBER schnell: Die Anfrage hat ein Timeout (standardmäßig 10 Sekunden, abhängig von der Integration), nach dem die Bestellung an einen anderen Partner geht

Checkliste für die Integration:

  1. Es müssen 3 Methoden und ein Webhook implementiert werden:

    GET_SERVICES - fragt die Anzahl der Nummern nach Land und Dienst bei Ihrem Server ab

    GET_NUMBER - reserviert eine Nummer für einen kurzen Zeitraum (standardmäßig 15 Minuten) mit angegebenen Parametern zum Empfang von SMS von einem bestimmten Dienst für einen angegebenen Betrag

    PUSH_SMS (Webhook) - wenn eine reservierte Nummer eine SMS empfängt, sendet Ihr Server sie an unseren Server

    FINISH_ACTIVATION - schließt den Vorgang mit bestimmten Parametern (abhängig vom Ergebnis)

  2. Kontaktieren Sie uns per E-Mail oder Telegram, um ein Partnerprofil zu erstellen, die URL für Anfragen von unserer Seite anzugeben, einen Link für den Webhook zu erhalten und die Nummern zu testen.
  3. Nach erfolgreichen Tests sind Ihre Nummern innerhalb weniger Stunden für unsere Kunden verfügbar.

v2 API

Die Reseller API v2 ermöglicht es Ihnen, Ihre Hardware und Nummern zu integrieren, damit Kunden sie anschließend über unsere Website für den SMS-Empfang nutzen können. Wir haben versucht, die Integration so einfach wie möglich zu gestalten. Um loszulegen, müssen Sie:

  1. 2 Methoden implementieren:
  • sendNumbersOnline - sendet die Liste Ihrer Nummern an unseren Server; diese Anfrage sollte alle 5 Minuten gesendet werden, um die Nummernliste zu aktualisieren und als Bestätigung der Betriebszeit Ihres Servers;

  • Weiterleitung eingehender SMS an unseren Server — addMessage (eine Nachricht pro Anfrage) oder addMessages (stapelweise).

  1. Den Support kontaktieren, um _SERVER_URL_ zu erhalten
  2. Die übrigen Anfragen sind optional, ihre Implementierung ist nicht erforderlich, ihre Beschreibung ist jedoch in der Dokumentation verfügbar.
  3. Die /api/resellers-Anfragen akzeptieren einen optionalen Parameter test zum Ausprobieren der Integration, in der Abfragezeichenfolge oder im Body: Mit test1 wird die Anfrage ausgeführt und wie üblich beantwortet, ihre Datenbankänderungen werden jedoch zurückgesetzt; mit test2 wird sie nicht ausgeführt, und die Antwort ist ein Dump der Anfrage, wie unser Server sie empfangen hat. Eine Anfrage mit test bestätigt nicht die Betriebszeit Ihres Servers.

Nachdem Sie eine Antwort erhalten haben, dass die Anfrage sendNumbersOnline erfolgreich ausgeführt wurde, wenden Sie sich an den Partner-Support, um zu prüfen, ob unser Server Nachrichten über die Anfragen addMessage oder addMessages empfängt. Im Erfolgsfall sind Ihre Nummern innerhalb weniger Stunden für unsere Kunden verfügbar.

Anhang


Prozessschema

Your serverOnlinesimserver(every 2 minutes)GET_SERVICES(service vk)Is the serviceavailable?NOYESMark vk as usedon the numberForward SMSto the webhookfor everynew SMSPUSH_SMS(closing an operation)FINISH_ACTIVATION(service vk)status is 3status is 4status is 1 or 5Endvk is used on the numberHow many timeswas vk issued?≤ 3> 3Cancel the operationfor vkBan vkfor this number

Nutzungsbedingungen:https://onlinesim.io/documentation/offer

Kontakt

Lizenz

GNU General Public License, version 3.0

Server

{yourserver}

URL Ihres Servers

Variablen:

NameStandardEnumerationBeschreibung
yourserverhttps://{yourserver.com}-