Alternative API

v1.0

Allgemeine Beschreibung

Alternative API ist mit dem sms-activate-Protokoll kompatibel: Programme, die dafür geschrieben wurden, arbeiten mit Onlinesim, nachdem die Adresse auf https://onlinesim.io/stubs/handler_api.php geändert wurde. Jede Methode ist eine GET-Anfrage an diese Adresse; der Parameter action wählt die Methode:

  https://onlinesim.io/stubs/handler_api.php?action=getBalance&api_key={api_key}

Die API bietet Zugriff auf zwei Dienste von Onlinesim: den Empfang von SMS von einem Dienst (Einzelaktivierungen) und die Miete von Nummern für den Empfang von SMS beliebiger Absender.

Liste der API-Anfragen

Profil

  • getBalance - gibt das Guthaben Ihres Profils zurück;
  • getCountries - gibt die Liste der Länder und ihrer IDs zurück.

Einzelaktivierungen

Eine Nummer empfängt SMS von einem Dienst innerhalb eines kurzen Zeitfensters (15 Minuten für die meisten Dienste). Der Dienst kann während der Operation nicht geändert werden: Bestellen Sie für einen anderen Dienst eine neue Nummer.

  • getNumbersStatus - Anzahl der verfügbaren Nummern pro Dienst in einem Land;
  • getNumber - bestellt eine Nummer des gewählten Landes für den gewählten Dienst;
  • getStatus - gibt den Code aus der empfangenen SMS zurück;
  • getFullSms - gibt den vollständigen Text der empfangenen SMS zurück;
  • setStatus - fordert die nächste SMS an oder schließt die Operation.

Miete

Eine gemietete Nummer empfängt SMS von beliebigen Absendern (einschließlich anderer Mobilnummern), außer verbotenen.

getQiwiRequisites wird aus Kompatibilitätsgründen angenommen und antwortet immer {"status":false}.

Die Postman-Sammlung ist hier verfügbar:

Run In Postman

Postman-Dokumentation

Antworten

  • Der HTTP-Status ist immer 200, Fehler stehen im Antworttext.
  • Textantworten (text/plain) haben die Form KEY:value (ACCESS_BALANCE:12.34) oder bestehen aus einem Code (BAD_KEY).
  • JSON-Fehler haben die Form {"status":"error","message":"<CODE>"}. Fehler, die jede Methode liefern kann (BAD_KEY, BANNED, BAD_ACTION, das Limit), kommen auch bei JSON-Methoden als Text.
  • Listen in JSON-Antworten kommen als Objekte mit den Schlüsseln "0", "1", …; eine leere Liste ist {}.
  • country ist eine Länder-ID der sms-activate-Nummerierung (id in getCountries, Russland ist 0), keine Vorwahl. Ohne country wird Russland verwendet.

Autorisierung

Der API-Schlüssel wird im Abfrageparameter api_key (der sms-activate-Name), in apikey oder key oder im Header Authorization: Bearer übergeben — der API-Schlüssel oder ein OAuth-Access-Token. Werden mehrere gesendet, gilt der erste in dieser Reihenfolge. Ein falscher oder fehlender Schlüssel in api_key ergibt BAD_KEY. Ein falscher Schlüssel in apikey, key oder Authorization wird vor der Ausführung der Methode abgelehnt: HTTP 456 mit {"response":"ERROR_WRONG_KEY"}.

Limits und Caching

  • getNumber, getRentNumber, setStatus und setRentStatus sind auf 3 Anfragen pro Sekunde und 150 Anfragen in 30 Sekunden pro Schlüssel begrenzt (pro IP ohne Schlüssel). Bei Überschreitung ist die Antwort der Text Too many requests. Please wait a moment before trying again. (HTTP 200). Lesende Methoden (Statusabfrage, Listen) haben kein eigenes Limit.
  • Die Website selbst erlaubt 400 Anfragen pro Minute: darüber ist die Antwort HTTP 429.
  • Die Antworten lesender Methoden (getBalance, getCountries, getNumbersStatus, getRentServicesAndCountries, getRentList, getRentStatus) werden 5 Sekunden zwischengespeichert: dieselbe Anfrage (gleiche Parameter und gleicher Schlüssel), die früher wiederholt wird, erhält dieselbe Antwort, Fehler eingeschlossen. getStatus und getFullSms werden hier nicht zwischengespeichert, aber den Zustand der Operation dahinter speichert die Onlinesim API bis zu 5 Sekunden (eine neue SMS kann mit dieser Verzögerung erscheinen; setStatus=3 zeigt die nächste SMS sofort). Methoden, die etwas ändern (getNumber, setStatus, getRentNumber, setRentStatus), werden nie zwischengespeichert.

Allgemeine Fehler

Textantwort Beschreibung
BAD_KEY Der API-Schlüssel ist falsch oder fehlt
BANNED Das Konto ist gesperrt
BAD_ACTION Unbekannte Methode oder ein Fehler ohne eigenen Code (zum Beispiel ein vorübergehender Fehler oder zu viele gleichzeitige Anfragen)
Too many requests. Please wait a moment before trying again. Das Anfragelimit des Konverters

Die Codes jeder Methode sind auf ihrer Seite aufgeführt.

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

Kontakt

Lizenz

GNU General Public License, version 3.0

Server

https://onlinesim.io

Onlinesim-Server