Use estos servicios web para crear un sistema de inicio de sesión por SMS para China.
URL base de la API
Su gestor de cuenta le asignará una URL base. Úsela con los endpoints que se describen a continuación para acceder a los servicios de autenticación.
Endpoint: POST /get-code
Use esta API para enviar un código de autenticación por SMS al teléfono del usuario.
Solicitud:
- Método HTTP: POST
- Formato: JSON
{
"key": "<API_KEY>",
"phone_no": "<PHONE_NO>"
}
Respuesta (si la solicitud tiene éxito)
{
"status": "ok",
"phone_no": "<PHONE_NO>"
}
Respuesta (si la solicitud falla)
{
"code": "<ERROR CODE>",
"msg": "<MESSAGE>"
}
Campos
key: su clave de API, asignada por su gestor de cuenta.phone_no: el número de teléfono del usuario al que se enviará el código de autenticación.status: devuelveoksi la solicitud tiene éxito.code: código de error que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.msg: mensaje breve que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.
Códigos de error y definiciones
0070: el formato de la solicitud no es JSON.0072: faltan los argumentosphone_nookeyen el JSON.0073: clave no válida. Contacte con su gestor de cuenta para obtener una clave de API.0075: número de teléfono no válido.0077: número de teléfono de prueba.
Endpoint: POST /check-code
Use esta API para iniciar la sesión de un usuario o registrar uno nuevo cuando se introduce un código de autenticación por SMS válido.
Solicitud
- Método HTTP: POST
- Formato: JSON
{
"key": "<API_KEY>",
"phone_no": "<PHONE_NO>",
"user_input_code": "..."
}
Respuesta (si la solicitud tiene éxito)
{
"status": "ok",
"yb_uid": "<>"
}
Respuesta (si la solicitud falla)
{
"code": "<ERROR CODE>",
"msg": "<MESSAGE>"
}
Campos
key: su clave de API, asignada por su gestor de cuenta.phone_no: el número de teléfono del usuario al que se enviará el código de autenticación.user_input_code: el código introducido por el usuario.status: devuelveoksi la solicitud tiene éxito.yb_uid: se devuelve cuando el usuario se registra o inicia sesión correctamente. Pase este UID a su aplicación para activar el inicio de sesión seguro.code: código de error que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.msg: mensaje breve que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.
Códigos de error y definiciones
0070: el formato de la solicitud no es JSON.0072: faltan los argumentosphone_nookeyen el JSON.0073: clave no válida. Contacte con su gestor de cuenta para obtener una clave de API.0075: número de teléfono no válido.0076: formato no válido del código de autenticación por SMS.0077: código no válido o caducado.0078: error del sistema. No se pudo crear la configuración de inicio de sesión seguro.0079: error del sistema. No se pudo crear la configuración de inicio de sesión seguro.0100: saldo insuficiente en su cuenta.-1: error inesperado del sistema.
Número de teléfono y código de prueba
Puede usar este número de teléfono y este código de autenticación por SMS para omitir el proceso de autenticación, únicamente con fines de prueba.
{
"key": "<API_KEY>",
"phone_no": "12345678910",
"user_input_code": "4433"
}
Endpoint: POST /u/<yb_uid>/devices
Use esta API para crear un nuevo dispositivo para el usuario.
Solicitud
- Método HTTP: POST
- Formato: JSON
{
"key": "<API_KEY>"
}
Respuesta (si la solicitud tiene éxito)
{
"status": "ok",
"device_id": "<DEVICE_ID>"
}
Respuesta (si la solicitud falla)
{
"code": "<ERROR CODE>",
"msg": "<MESSAGE>"
}
Campos
key: su clave de API, asignada por su gestor de cuenta.status: devuelveoksi la solicitud tiene éxito.device_id: se devuelve cuando se crea correctamente un nuevo dispositivo. Pase este ID a su aplicación para activar el inicio de sesión seguro.code: código de error que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.msg: mensaje breve que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.
Códigos de error y definiciones
0070: el formato de la solicitud no es JSON.0071: falta el argumentokeyen el JSON.0073: clave no válida. Contacte con su gestor de cuenta para obtener una clave de API.0078: error del sistema. No se pudo crear la configuración de inicio de sesión seguro.0079: error del sistema. No se pudo crear la configuración de inicio de sesión seguro.0200: UID no válido.0202: el usuario no existe.-1: error inesperado del sistema.
Endpoint: GET /u/<yb_uid>/devices
Use esta API para obtener la lista de dispositivos de un usuario.
Solicitud
- Método HTTP: GET
Respuesta (si la solicitud tiene éxito)
{
"status": "ok",
"device_ids": [
"<DEVICE_ID_1>",
"<DEVICE_ID_2>",
...
]
}
Respuesta (si la solicitud falla)
{
"code": "<ERROR_CODE>",
"msg": "<MESSAGE>"
}
Campos
status: devuelveoksi la solicitud tiene éxito.device_ids: devuelve la lista de dispositivos del usuario. Aquí solo se muestran los 10 dispositivos creados más recientemente.code: código de error que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.msg: mensaje corto que se devuelve cuando la solicitud falla. Consulte la sección de códigos de error para más detalles.
Códigos de error y definiciones
0200: UID no válido.0202: el usuario no existe.-1: error inesperado del sistema.