Vom 21YunBox China Engineering-Team · Veröffentlicht 2. Juli 2020

Nutzen Sie diese Webdienste, um ein SMS-basiertes Anmeldesystem für China zu bauen.

API-Basis-URL

Ihr Account Manager weist Ihnen eine Basis-URL zu. Verwenden Sie sie zusammen mit den unten stehenden Endpunkten, um auf die Auth-Dienste zuzugreifen.

Endpunkt: POST /get-code

Verwenden Sie diese API, um einen SMS-Authentifizierungscode an das Telefon des Nutzers zu senden.

Request:

  • HTTP-Methode: POST
  • Format: JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>"
}

Response (bei Erfolg)

{
    "status": "ok",
    "phone_no": "<PHONE_NO>"
}

Response (bei Fehlschlag)

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

Felder

  • key: Ihr API-Schlüssel, zugewiesen von Ihrem Account Manager.
  • phone_no: Die Telefonnummer des Nutzers, an die der Authentifizierungscode gesendet wird.
  • status: Gibt ok zurück, wenn die Anfrage erfolgreich ist.
  • code: Ein Fehlercode, der bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.
  • msg: Eine kurze Meldung, die bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.

Fehlercodes und Definitionen

  • 0070: Request-Format ist nicht JSON.
  • 0072: Fehlende Argumente phone_no oder key im JSON.
  • 0073: Ungültiger Schlüssel. Kontaktieren Sie Ihren Account Manager, um einen API-Schlüssel zu erhalten.
  • 0075: Ungültige Telefonnummer.
  • 0077: Test-Telefonnummer.

Endpunkt: POST /check-code

Verwenden Sie diese API, um einen Nutzer anzumelden oder neu zu registrieren, wenn ein gültiger SMS-Authentifizierungscode eingegeben wird.

Request

  • HTTP-Methode: POST
  • Format: JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>",
    "user_input_code": "..."
}

Response (bei Erfolg)

{
  "status": "ok",
  "yb_uid": "<>"
}

Response (bei Fehlschlag)

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

Felder

  • key: Ihr API-Schlüssel, zugewiesen von Ihrem Account Manager.
  • phone_no: Die Telefonnummer des Nutzers, an die der Authentifizierungscode gesendet wird.
  • user_input_code: Der vom Nutzer eingegebene Code.
  • status: Gibt ok zurück, wenn die Anfrage erfolgreich ist.
  • yb_uid: Wird zurückgegeben, wenn der Nutzer erfolgreich registriert oder angemeldet ist. Übergeben Sie diese UID an Ihre App, um die verschlüsselte Verbindung zu aktivieren.
  • code: Ein Fehlercode, der bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.
  • msg: Eine kurze Meldung, die bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.

Fehlercodes und Definitionen

  • 0070: Request-Format ist nicht JSON.
  • 0072: Fehlende Argumente phone_no oder key im JSON.
  • 0073: Ungültiger Schlüssel. Kontaktieren Sie Ihren Account Manager, um einen API-Schlüssel zu erhalten.
  • 0075: Ungültige Telefonnummer.
  • 0076: Ungültiges Format des SMS-Authentifizierungscodes.
  • 0077: Ungültiger oder abgelaufener Code.
  • 0078: Systemfehler. Erstellen der Verbindungskonfiguration fehlgeschlagen.
  • 0079: Systemfehler. Erstellen der Verbindungskonfiguration fehlgeschlagen.
  • 0100: Unzureichendes Guthaben in Ihrem Konto.
  • -1: Unerwarteter Systemfehler.

Test-Telefonnummer und -Code

Sie können diese Telefonnummer und diesen SMS-Authentifizierungscode verwenden, um den Authentifizierungsprozess ausschließlich zu Testzwecken zu überspringen.

{
    "key": "<API_KEY>",
    "phone_no": "12345678910",
    "user_input_code": "4433"
}

Endpunkt: POST /u/<yb_uid>/devices

Verwenden Sie diese API, um ein neues Gerät für den Nutzer zu erstellen.

Request

  • HTTP-Methode: POST
  • Format: JSON
{
    "key": "<API_KEY>"
}

Response (bei Erfolg)

{
  "status": "ok",
  "device_id": "<DEVICE_ID>"
}

Response (bei Fehlschlag)

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

Felder

  • key: Ihr API-Schlüssel, zugewiesen von Ihrem Account Manager.
  • status: Gibt ok zurück, wenn die Anfrage erfolgreich ist.
  • device_id: Wird zurückgegeben, wenn ein neues Gerät erfolgreich erstellt wird. Übergeben Sie diese ID an Ihre App, um die verschlüsselte Verbindung zu aktivieren.
  • code: Ein Fehlercode, der bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.
  • msg: Eine kurze Meldung, die bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.

Fehlercodes und Definitionen

  • 0070: Request-Format ist nicht JSON.
  • 0071: Fehlendes Argument key im JSON.
  • 0073: Ungültiger Schlüssel. Kontaktieren Sie Ihren Account Manager, um einen API-Schlüssel zu erhalten.
  • 0078: Systemfehler. Erstellen der Verbindungskonfiguration fehlgeschlagen.
  • 0079: Systemfehler. Erstellen der Verbindungskonfiguration fehlgeschlagen.
  • 0200: Ungültige UID.
  • 0202: Nutzer existiert nicht.
  • -1: Unerwarteter Systemfehler.

Endpunkt: GET /u/<yb_uid>/devices

Verwenden Sie diese API, um eine Liste der Geräte zu erhalten, die ein Nutzer besitzt.

Request

  • HTTP-Methode: GET

Response (bei Erfolg)

{
  "status": "ok",
  "device_ids": [
      "<DEVICE_ID_1>",
      "<DEVICE_ID_2>",
      ...
  ]
}

Response (bei Fehlschlag)

{
    "code": "<ERROR_CODE>",
    "msg": "<MESSAGE>"
}

Felder

  • status: Gibt ok zurück, wenn die Anfrage erfolgreich ist.
  • device_ids: Gibt eine Liste der Geräte zurück, die der Nutzer besitzt. Hier werden nur die 10 zuletzt erstellten Geräte angezeigt.
  • code: Ein Fehlercode, der bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.
  • msg: Eine kurze Meldung, die bei fehlgeschlagener Anfrage zurückgegeben wird. Einzelheiten im Abschnitt zu den Fehlercodes.

Fehlercodes und Definitionen

  • 0200: Ungültige UID.
  • 0202: Nutzer existiert nicht.
  • -1: Unerwarteter Systemfehler.

21YunBox ausprobieren?

Beratung anfragen