Allgemeine Beschreibung ​

Diese APIs sind für aktuelle und potenzielle Onlinesim-Partner gedacht. Sie ermöglichen es, 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 API-Versionen implementiert:

• v1 eignet sich für Partner, die bereits eine eigene Logik für die Arbeit mit Nummern haben. In diesem Schema wendet sich unser Server an Ihren, um Informationen über verfügbare Nummern zu erhalten, und wenn eine passende Nummer gefunden wird, fordert er sie für den SMS-Empfang an.

• v2 hat ein umgekehrtes Schema: Die Hauptlogik der Operationen liegt auf unserer Seite. Sie übermitteln uns regelmäßig eine Liste Ihrer Nummern und leiten eingehende SMS weiter, wobei die Nummern selbst sofort für Bestellungen durch Kunden verfügbar sind.

v1 API ​

Die gesamte Interaktion erfolgt über HTTP POST- und/oder GET-Anfragen zwischen den von Ihnen angegebenen und unseren Support-Endpunkten.

Anforderungen für v1: ​

1. Anfrage-/Antwortformat: JSON4

2. Codierung: UTF-8

3. Stellen Sie sicher, dass user-agent in den Anfrageheadern enthalten ist

4. Alle Anfragen/Antworten verwenden die gzip-Komprimierungsmethode

5. Die verwendeten Ländernamen und Dienstnamen in der Antwort GET_SERVICES müssen mit den entsprechenden Listen von Ländern und Diensten übereinstimmen

6. Eine Nummer sollte nur für einen Vorgang gleichzeitig verwendet werden: Ihr Server kann dieselbe Nummer für einen anderen Dienst nur ausgeben, nachdem der vorherige Vorgang abgeschlossen wurde

7. Es ist notwendig, eine Funktion zum Ausschließen der Ausgabe von Nummern mit bestimmten Masken zu implementieren: Wenn in der Anfrage eine Ausschlussmaske angegeben ist, sollten Nummern mit einer solchen Ziffernfolge nicht ausgegeben werden (für die Anfrage GET_NUMBER)

8. Webhook PUSH_SMS: Ihr Server sollte SMS, die von Nummern mit aktiven Operationen empfangen wurden, automatisch an den Onlinesim-Server weiterleiten

9. Die Filterung kann sowohl auf unserer Seite als auch auf Ihrer Seite erfolgen. Informieren Sie vor der Integration, welche Option für Sie bevorzugt ist

10. Die Ausgabe der Nummer sollte innerhalb von 10 Sekunden ab dem Zeitpunkt des Erhalts der Anfrage GET_NUMBER (und GET_NUMBER (RENT)) erfolgen, andernfalls wird die Nummerbestellung abgebrochen

Checkliste für die Integration: ​

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

   GET_SERVICES - fragt bei Ihrem Server die Anzahl der Nummern nach Ländern und Diensten an

   GET_NUMBER - reserviert eine Nummer für 15 Minuten mit den angegebenen Parametern für den Empfang von SMS-Nachrichten von einem bestimmten Dienst für den angegebenen Betrag

   PUSH_SMS (webhook) - wenn SMS von einer reservierten Nummer empfangen werden, sendet Ihr Server sie an unseren Server

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

2. Schreiben Sie uns per E-Mail oder Telegram, um ein Partnerprofil zu erstellen, URL für Anfragen von unserer Seite bereitzustellen, einen Link für den Webhook zu erhalten und Nummern zu testen.

3. Nach erfolgreich durchgeführten Tests werden Ihre Nummern innerhalb weniger Stunden für unsere Kunden verfügbar sein

v2 API ​

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

1. 2 Methoden implementieren:

• sendNumbersOnline - übermittelt eine Liste Ihrer Nummern an unseren Server, diese Anfrage sollte alle 5 Minuten gesendet werden, um die Nummernliste zu aktualisieren und als Bestätigung der Uptime Ihres Servers;

  TIP

  Wenn Sie planen, eine große Anzahl von Nummern zu verwenden und das Senden von sendNumbersOnline alle 5 Minuten als Bestätigung der Uptime für Sie schwierig ist, empfehlen wir, die alternative Option zu verwenden - die Anfrage checkWork.

• addMessage - leitet die von Ihrem Server empfangenen Nachrichten an uns weiter.

2. Kontaktieren Sie den Support, um _SERVER_URL_ zu erhalten

3. Die restlichen Anfragen sind optional, ihre Implementierung ist nicht erforderlich, aber ihre Beschreibung ist in der Dokumentation verfügbar.

4. Die Anfragen haben einen optionalen Parameter test, der für Tests verwendet werden kann. Er kann die Werte test1 und test2 annehmen. Wenn er gleich dem ersten ist, ermöglicht er der Anfrage, den Server zu erreichen, führt jedoch nicht zur Ausführung der Funktion. Wenn ihm der Wert test2 zugewiesen wird, gibt er den Text Ihrer Anfrage in der Antwort zurück.

Nachdem Sie eine Antwort über die erfolgreich ausgeführte Anfrage sendNumbersOnline erhalten haben, kontaktieren Sie den Partner-Support, damit die Mitarbeiter überprüfen, ob unser Server Nachrichten über die Anfrage addMessage empfängt. Bei Erfolg werden Ihre Nummern bereits nach wenigen Stunden für unsere Kunden verfügbar sein.

Anwendungen

Prozessschema ​