Autorisierung

Geheimer Schlüssel, der für die vereinfachte Autorisierung in der Onlinesim API verwendet wird.

---

So erhalten Sie einen API-Schlüssel:

1. Melden Sie sich in Ihrem persönlichen Konto an, gehen Sie zu den Profileinstellungen und wählen Sie die Registerkarte API.
2. Der Schlüssel wird in der Zeile API key angezeigt. Sie müssen ihn kopieren und zu Ihrer Anwendung/Programm hinzufügen.

---

So verwenden Sie ihn:

1. Alle Anfragen an die aktuelle Onlinesim API (außer getFreeList) müssen einen API-Schlüssel enthalten.

2. Der API-Schlüssel kann als Anfrageparameter angegeben werden, z. B.:

      https://onlinesim.io/api/getTariffs.php?api_key={api_key}

Der API-Schlüssel kann auch für die Autorisierung im Anfrageheader verwendet werden, indem das Schema Authorization: Bearer verwendet wird, z. B.:

Authorization: Bearer {api_key}
User-Agent: PostmanRuntime/7.29.2
Accept: */\*
Cache-Control: no-cache
Postman-Token: 948bc880-8d25-4298-994f-fe6e22ada339
Host: onlinesim.io
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Cookie: xxxx

OAuth 2.0

Das OAuth 2.0-Protokoll unterstützt mehrere Autorisierungsszenarien. Für die Arbeit mit unserer API können Sie die Szenarien Authorization Code Flow oder Implicit Flow verwenden.

Authorization URL: https://onlinesim.io/oauth/authorize

Token URL: https://onlinesim.io/oauth/token

Scopes:

• sms-scope gewährt Zugriff auf die Verwaltung von Nummern für den Dienst "SMS-Empfang" von Onlinesim;
• rent-scope gewährt Zugriff auf die Vermietung virtueller Telefonnummern von Onlinesim;
• free-scope gewährt Zugriff auf die Verwendung kostenloser Nummern von Onlinesim.

Registrierung Ihrer Anwendung auf unserem Autorisierungsdienst

1. Gehen Sie zur OAuth-Seite

2. Erstellen Sie einen neuen Client und geben Sie an:

   • Name - Name der Anwendung oder ein anderer Name, den Sie und Ihre Benutzer mit der Anwendung assoziieren werden;
   • Redirect URL - URL, an die der Client nach der Autorisierung weitergeleitet wird und wohin der Autorisierungscode der Anwendung gesendet wird;
   • Confidential - optional, markieren Sie den Client als Confidential, wenn Ihre Anwendung auf einem Server läuft und den Client Secret sicher speichern kann.

3. Klicken Sie auf "Create". Ihre hinzugefügte Anwendung wird in der Liste der Clients angezeigt.

4. Speichern Sie Client ID und Secret an einem sicheren Ort, sie werden von Ihrer Anwendung für die Autorisierung verwendet.

OAuth 2.0. Authorization Code Flow

Benutzerautorisierung und Token-Erhaltung

1. Autorisieren Sie den Client über eine GET-Anfrage an https://onlinesim.io/oauth/authorize mit den Parametern client_id, redirect_uri, response_type, scope, state:

Parameterbeschreibung

Parametername	Datentyp	Beschreibung
client_id	STRING	Client ID, der nach der Registrierung der Anwendung erhalten wurde
redirect_uri	STRING	Adresse, an die der Client nach erfolgreicher Autorisierung weitergeleitet wird, muss mit der Redirect URL übereinstimmen, die Sie bei der Registrierung der Anwendung angegeben haben.
response_type	STRING	Geben Sie code an
scope	STRING	Zugriffsrechte, deren Genehmigung Ihre Anwendung vom Benutzer anfordert. Mögliche Optionen: sms-scope, rent-scope, free-scope. Mehrere Werte können angegeben werden
state	STRING	Zufällige Zeichenfolge zum Schutz vor CSRF (überprüfen Sie sie nach der Weiterleitung)

2. Nach der Anfrage an https://onlinesim.io/oauth/authorize wird der Benutzer aus Ihrer Anwendung zur Autorisierungsseite weitergeleitet, wo er Benutzername und Passwort eingeben muss und bei Erfolg Ihre Anwendung für die Arbeit mit den Benutzerdaten im Onlinesim-Dienst autorisieren muss. Dazu muss er auf die Schaltfläche Authorize klicken:

3. Bei erfolgreicher Autorisierung wird der Benutzer an die Adresse redirect_uri mit dem Parameter code weitergeleitet. Jetzt können Sie ein access token erhalten, dazu müssen Sie eine POST-Anfrage an https://onlinesim.io/oauth/token stellen:

Parameterbeschreibung

Parametername	Datentyp	Beschreibung
grant_type	STRING	Autorisierungsszenario, für das Szenario Authorization Code müssen Sie authorization_code angeben
client_id	STRING	Client ID, der nach der Registrierung der Anwendung erhalten wurde
client_secret	STRING	Client_secret, der nach der Registrierung der Anwendung erhalten wurde
redirect_uri	STRING	Adresse, an die der Client nach erfolgreicher Autorisierung weitergeleitet wird, muss mit der Redirect URL übereinstimmen, die Sie bei der Registrierung der Anwendung angegeben haben
code	STRING	Autorisierungscode, der in der vorherigen Stufe erhalten wurde

4. Als Ergebnis einer erfolgreichen Anfrage an https://onlinesim.io/oauth/token erhalten Sie eine JSON-Antwort, die die Felder access_token, refresh_token und expires_in enthält. Das Feld expires_in bestimmt die Anzahl der Sekunden bis zum Ablauf des Zugriffstokens, refresh_token wird verwendet, um das Zugriffstoken bei Ablauf zu aktualisieren.

---

Autorisierung von Anfragen an die Onlinesim API und Token-Aktualisierung

Zu allen Anfragen an die API muss der Header Authorization: Bearer access_token hinzugefügt werden. Wenn als Antwort auf Ihre Anfrage ERROR_WRONG_KEY kam, müssen Sie das Token aktualisieren oder ein neues erhalten.

{
  "response": "ERROR_WRONG_KEY"
}

Um das Token zu aktualisieren, müssen Sie eine POST-Anfrage an https://onlinesim.io/oauth/token mit den Parametern grant_type, client_id, client_secret und refresh_token stellen. Für das Feld refresh_token muss der Wert verwendet werden, der in Schritt 4 erhalten wurde.

Parameterbeschreibung

Parametername	Datentyp	Beschreibung
grant_type	STRING	Sie müssen refresh_token angeben
client_id	STRING	client ID, den Sie bei der Registrierung der Anwendung erhalten haben
client_secret	STRING	client_secret, der bei der Registrierung der Anwendung erhalten wurde
refresh_token	STRING	refresh_token wurde zusammen mit access_token erhalten. Hat eine viel längere Lebensdauer und wird verwendet, um access_token zu aktualisieren

OAuth 2.0. Implicit Flow

Benutzerautorisierung und Token-Erhaltung

1. Autorisieren Sie den Client über eine GET-Anfrage an https://onlinesim.io/oauth/authorize mit den Parametern client_id, redirect_uri, response_type, scope, state:

Parameterbeschreibung

Parametername	Datentyp	Beschreibung
client_id	STRING	Client ID, der bei der Registrierung der Anwendung erhalten wurde
redirect_uri	STRING	Adresse, an die der Client nach erfolgreicher Autorisierung weitergeleitet wird, muss mit der Redirect URL übereinstimmen, die Sie beim Hinzufügen der Anwendung angegeben haben.
response_type	STRING	Verwenden Sie token als Wert
scope	STRING	Zugriffsrechte, deren Genehmigung Ihre Anwendung vom Benutzer anfordert. Mögliche Optionen: sms-scope, rent-scope, free-scope. Mehrere Werte können angegeben werden
state	STRING	Zufällige Zeichenfolge zum Schutz vor CSRF (überprüfen Sie sie nach der Weiterleitung)

2. Nach der Anfrage an https://onlinesim.io/oauth/authorize wird der Benutzer aus Ihrer Anwendung zur Autorisierungsseite weitergeleitet, wo er Benutzername und Passwort eingeben muss und bei Erfolg Ihre Anwendung für die Arbeit mit den Benutzerdaten im Onlinesim-Dienst autorisieren muss. Dazu muss er auf die Schaltfläche Authorize klicken:

3. Bei erfolgreicher Autorisierung wird der Benutzer an die Adresse redirect_uri mit dem Parameter access_token weitergeleitet. Dies ist das erforderliche Token für die Autorisierung in der Onlinesim API.

---

Autorisierung von Anfragen an die Onlinesim API

Zu allen Anfragen an die API muss der Header Authorization: Bearer access_token hinzugefügt werden. Wenn als Antwort auf Ihre Anfrage ERROR_WRONG_KEY kam, müssen Sie ein neues Token erhalten.

{
  "response": "ERROR_WRONG_KEY"
}