Utilisez ces services web pour bâtir un système de connexion par SMS pour la Chine.

URL de base de l’API

Une URL de base vous sera attribuée par votre gestionnaire de compte. Utilisez-la avec les points de terminaison ci-dessous pour accéder aux services d’authentification.

Point de terminaison : POST /get-code

Utilisez cette API pour envoyer un code d’authentification SMS au téléphone de l’utilisateur.

Requête :

  • Méthode HTTP : POST
  • Format : JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>"
}

Réponse (en cas de succès)

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

Réponse (en cas d’échec)

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

Champs

  • key : votre clé d’API, attribuée par votre gestionnaire de compte.
  • phone_no : le numéro de téléphone de l’utilisateur où le code d’authentification sera envoyé.
  • status : renvoie ok si la requête réussit.
  • code : un code d’erreur renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.
  • msg : un court message renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.

Codes d’erreur et définitions

  • 0070 : le format de la requête n’est pas JSON.
  • 0072 : arguments phone_no ou key manquants dans le JSON.
  • 0073 : clé invalide. Contactez votre gestionnaire de compte pour obtenir une clé d’API.
  • 0075 : numéro de téléphone invalide.
  • 0077 : numéro de téléphone de test.

Point de terminaison : POST /check-code

Utilisez cette API pour connecter ou enregistrer un nouvel utilisateur lorsqu’un code d’authentification SMS valide est saisi.

Requête

  • Méthode HTTP : POST
  • Format : JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>",
    "user_input_code": "..."
}

Réponse (en cas de succès)

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

Réponse (en cas d’échec)

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

Champs

  • key : votre clé d’API, attribuée par votre gestionnaire de compte.
  • phone_no : le numéro de téléphone de l’utilisateur où le code d’authentification sera envoyé.
  • user_input_code : le code saisi par l’utilisateur.
  • status : renvoie ok si la requête réussit.
  • yb_uid : renvoyé lorsque l’utilisateur est enregistré ou connecté avec succès. Transmettez cet UID à votre application pour activer la connexion sécurisée.
  • code : un code d’erreur renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.
  • msg : un court message renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.

Codes d’erreur et définitions

  • 0070 : le format de la requête n’est pas JSON.
  • 0072 : arguments phone_no ou key manquants dans le JSON.
  • 0073 : clé invalide. Contactez votre gestionnaire de compte pour obtenir une clé d’API.
  • 0075 : numéro de téléphone invalide.
  • 0076 : format invalide du code d’authentification SMS.
  • 0077 : code invalide ou expiré.
  • 0078 : erreur système. Échec de la création de la configuration de connexion sécurisée.
  • 0079 : erreur système. Échec de la création de la configuration de connexion sécurisée.
  • 0100 : solde insuffisant sur votre compte.
  • -1 : erreur système inattendue.

Numéro de téléphone et code de test

Vous pouvez utiliser ce numéro de téléphone et ce code d’authentification SMS pour contourner le processus d’authentification à des fins de test uniquement.

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

Point de terminaison : POST /u/<yb_uid>/devices

Utilisez cette API pour créer un nouvel appareil pour l’utilisateur.

Requête

  • Méthode HTTP : POST
  • Format : JSON
{
    "key": "<API_KEY>"
}

Réponse (en cas de succès)

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

Réponse (en cas d’échec)

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

Champs

  • key : votre clé d’API, attribuée par votre gestionnaire de compte.
  • status : renvoie ok si la requête réussit.
  • device_id : renvoyé lorsqu’un nouvel appareil est créé avec succès. Transmettez cet ID à votre application pour activer la connexion sécurisée.
  • code : un code d’erreur renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.
  • msg : un court message renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.

Codes d’erreur et définitions

  • 0070 : le format de la requête n’est pas JSON.
  • 0071 : argument key manquant dans le JSON.
  • 0073 : clé invalide. Contactez votre gestionnaire de compte pour obtenir une clé d’API.
  • 0078 : erreur système. Échec de la création de la configuration de connexion sécurisée.
  • 0079 : erreur système. Échec de la création de la configuration de connexion sécurisée.
  • 0200 : UID invalide.
  • 0202 : l’utilisateur n’existe pas.
  • -1 : erreur système inattendue.

Point de terminaison : GET /u/<yb_uid>/devices

Utilisez cette API pour obtenir la liste des appareils que possède un utilisateur.

Requête

  • Méthode HTTP : GET

Réponse (en cas de succès)

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

Réponse (en cas d’échec)

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

Champs

  • status : renvoie ok si la requête réussit.
  • device_ids : renvoie la liste des appareils que possède l’utilisateur. Seuls les 10 appareils créés les plus récemment sont affichés ici.
  • code : un code d’erreur renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.
  • msg : un bref message renvoyé lorsque la requête échoue. Référez-vous à la section des codes d’erreur pour les détails.

Codes d’erreur et définitions

  • 0200 : UID invalide.
  • 0202 : l’utilisateur n’existe pas.
  • -1 : erreur système inattendue.

Essayer 21YunBox ?

Demander une consultation