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 zur Verfügung stellen, um SMS von verschiedenen Diensten und Anwendungen zu empfangen.

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 kontaktiert unser Server Ihren Server nach Informationen über verfügbare Nummern und fordert, wenn eine geeignete Nummer gefunden wird, diese an, um SMS zu empfangen.
v2 hat ein umgekehrtes Schema: Die Hauptlogik der Operationen befindet sich auf unserer Seite. Sie senden uns regelmäßig eine Liste Ihrer Nummern und leiten eingehende SMS an diese weiter, während die Nummern sofort für Kundenbestellungen verfügbar sind.

v1 API

Alle Interaktionen erfolgen über HTTP POST- und/oder GET-Anfragen zwischen dem von Ihnen angegebenen Endpunkt und unserem Support.

API v1

Anforderungen für v1:

Anforderungs-/Antwortformat: JSON4
Codierung: UTF-8
Stellen Sie sicher, dass der User-Agent in den Anforderungsheadern enthalten ist
Alle Anfragen/Antworten verwenden die Gzip-Komprimierung
Die in der Antwort von GET_SERVICES verwendeten Ländernamen und Dienste müssen mit den entsprechenden Listen von Ländern und Diensten übereinstimmen
Eine Nummer sollte nur für eine Operation gleichzeitig verwendet werden: Ihr Server kann diese gleiche Nummer für einen anderen Dienst erst dann ausgeben, wenn die vorherige Operation abgeschlossen ist
Es ist erforderlich, eine Funktionalität zu implementieren, um die Ausgabe von Nummern mit bestimmten Masken auszuschließen: Wenn in der Anfrage eine Ausschlussmaske angegeben ist, sollten Nummern mit einer solchen Ziffernfolge nicht ausgegeben werden (für die Anfrage GET_NUMBER)
Webhook PUSH_SMS: Ihr Server muss automatisch SMS, die von Nummern mit aktiven Operationen empfangen werden, an den Onlinesim-Server weiterleiten
Die Filterung kann entweder auf unserer Seite oder auf Ihrer Seite durchgeführt werden. Informieren Sie uns vor der Integration, welche Option für Sie vorzuziehen ist
Die Nummer muss innerhalb von 10 Sekunden nach Erhalt der GET_NUMBER- (und GET_NUMBER (RENT)) Anfrage ausgegeben werden, andernfalls wird die Nummernbestellung storniert

Checkliste für die Integration:

Es ist erforderlich, 3 Methoden und einen Webhook zu implementieren:

GET_SERVICES - fordert die Anzahl der Nummern nach Land und Dienst von Ihrem Server an

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

PUSH_SMS (Webhook) - wenn eine SMS von einer reservierten Nummer empfangen wird, sendet Ihr Server sie an unseren Server

FINISH_ACTIVATION - schließt die Operation mit bestimmten Parametern ab (abhängig vom Ergebnis)
Schreiben Sie uns eine E-Mail oder eine Nachricht in Telegram, um ein Partnerprofil zu erstellen, die URL für Anfragen von unserer Seite bereitzustellen, den Link für den Webhook zu erhalten und die Nummern zu testen.
Nach erfolgreich durchgeführten Tests sind Ihre Nummern innerhalb weniger Stunden für unsere Kunden verfügbar.

v2 API

Das Reseller API v2 ermöglicht es Ihnen, Ihre Hardware und Nummern zu integrieren, damit sie später von Kunden über unsere Website zur Annahme von SMS verwendet werden können. Wir haben versucht, es so einfach wie möglich zu gestalten. Um loszulegen, müssen Sie:

Implementieren Sie 2 Methoden:

* [sendNumbersOnline](/de/Reseller-API-UN/Reseller-API-UN-post-api-resellers-sendnumbersonline) - überträgt die Liste Ihrer Nummern an unseren Server, diese Anfrage sollte alle 5 Minuten gesendet werden, um die Liste der Nummern zu aktualisieren und als Bestätigung der Betriebszeit Ihres Servers;

::callout{type="tip"}
Wenn Sie eine große Anzahl von Nummern verwenden möchten und das Senden von [sendNumbersOnline](/de/Reseller-API-UN/Reseller-API-UN-post-api-resellers-sendnumbersonline) alle 5 Minuten als Bestätigung der Betriebszeit für Sie schwierig ist, empfehlen wir Ihnen, die alternative Option zu verwenden - die Anfrage [checkWork](/de/Reseller-API-UN/Reseller-API-UN-get-api-resellers).
::

* Weiterleitung eingehender SMS an unseren Server — [addMessage](/de/Reseller-API-UN/Reseller-API-UN-post-api-resellers-addmessage) (eine Nachricht pro Anfrage) oder [addMessages](/de/Reseller-API-UN/Reseller-API-UN-post-api-resellers-addmessages) (stapelweise).

::callout{type="tip"}
Es wird empfohlen, anstelle von [addMessage](/de/Reseller-API-UN/Reseller-API-UN-post-api-resellers-addmessage) [addMessages](/de/Reseller-API-UN/Reseller-API-UN-post-api-resellers-addmessages) zu verwenden und SMS in Paketen zu senden, z. B. einmal alle 5 Sekunden.
::

Kontaktieren Sie den Support, um _SERVER_URL_ zu erhalten
Die restlichen Anfragen sind optional, ihre Implementierung ist nicht erforderlich, aber ihre Beschreibung ist in der Dokumentation verfügbar.
Anfragen haben einen optionalen Parameter test, der für Testzwecke verwendet werden kann. Er kann die Werte test1 und test2 annehmen, wobei er beim ersten Wert die Anfrage an den Server weiterleitet, jedoch keine Funktion ausführt. Wenn ihm der Wert test2 zugewiesen wird, gibt er den Körper Ihrer Anfrage in der Antwort zurück. Der Parameter kann sowohl in der Abfragezeichenfolge (z. B. für GET-Methoden) als auch als Feld in ihrem Körper (z. B. für POST-Methoden) übergeben werden - beide Varianten sind gültig.

Nachdem Sie die Antwort auf die erfolgreich ausgeführte Anfrage sendNumbersOnline erhalten haben, wenden Sie sich an den Partner-Support, damit die Mitarbeiter überprüfen können, ob unser Server Nachrichten mit den Anfragen addMessage oder addMessages erhält. Im Erfolgsfall sind Ihre Nummern innerhalb weniger Stunden für unsere Kunden verfügbar.

Anwendungen

Prozessschema

Terms of Service: https://onlinesim.io/documentation/offer

Kontakt

Email: partners@onlinesim.ru
URL: https://onlinesim.io

Lizenz

GNU General Public License, version 3.0

Server

`{yourserver}`

URL Ihres Servers

Variablen:

Name	Standard	Enumeration	Beschreibung
`yourserver`	`https://{yourserver.com}`	---	---