Cómo utilizar la API en la práctica

  • 1. Ejemplo: Registrar un nuevo usuario

 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L51

 

  • 2. Ejemplo: Actualizar la información de perfil de un usuario

 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L63

 

  • 3. Ejemplo: Obtener la información de perfil de un usuario

 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L63

 

  • 4. Ejemplo: Visualizar un grupo de usuarios

 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L161

 

  • 5. Ejemplo: Obtener datos de desempeño y del progreso en la unidad de un grupo de usuarios específico

 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L196

 

  • 6. Ejemplo: Obtener una lista de todos los usuarios de tu organización

 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L189

 

  • 7. Ejemplo: Inicio de sesión único - Obtener una URL con un auth_token para que el usuario pueda iniciar sesión automáticamente en Voxy

 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L70

 

  1. Problemas comunes

 

  • 1. 401 - Unauthorized. No se pudo verificar la identidad del solicitante.

 

Este error indica que tu solicitud NO incluía un encabezado de autorización válido y, por lo tanto, no se pudo verificar la identidad del solicitante y se rechazó la solicitud. Por lo general, esto se debe que se utilizó una REQUEST_SIGNATURE mal generada.

 

Para generar la firma correctamente, tu código debería pasar por las siguientes etapas:

  1. Obtener todos los parámetros incluidos en la solicitud y ordenarlos alfabéticamente.
  2. Utilizar códigos URL en los parámetros ordenados alfabéticamente.
  3. Crear una cadena de texto que incluya la concatenación de tu firma API y los parámetros con codificación URL del paso 2 (por ejemplo, {{API_SECRET}}+{{URL_ENCODED_PARAMETERS}}).
  4. Encriptar la cadena utilizando el algoritmo de hash SHA-256.

 

            Como resultado, se obtiene una firma encriptada de 256 bits como la siguiente: 24412158fe201e7d4d0a22f16b302c3252428ad129d1398eb5d2248d73223a67

 

Esta firma se utiliza en el encabezado de autorización que se incluye con tu solicitud para la Voxy Partner API. El encabezado de autorización debería verse así:

 

{
  "Authorization": "Voxy xPLo0vQ3opfMt9aV:24412158fe201e7d4d0a22f16b302c3252428ad129d1398eb5d2248d73223a67"
}

 

Si utilizas parámetros con caracteres especiales, asegúrate de usar la codificación URL no solo en los parámetros, sino también en el proceso de creación de la firma. De lo contrario, no serán equivalentes, se generarán firmas distintas y tu solicitud será rechazada.

 

 

  • 2. 400 - Bad request

 

Este tipo de error puede aparecer si incluiste parámetros con formato incorrecto. Por ejemplo, la mayoría de los parámetros de fecha de la Voxy Partner API exigen el uso del formato AAAA-MM-DD.  Si envías la fecha en otro formato, recibirás una notificación de error 400 - Bad request.

 

Para asegurarte de que tu solicitud tenga todos los parámetros correctos, consulta los documentos sobre la Voxy Partner API en http://partner-api-docs.voxy.com/docs/.

 

  • 3. 409 - Conflict. El usuario ya pertenece a otra organización.

 

Puedes recibir este error cuando estás registrando un nuevo usuario o estudiante. Esto significa que el correo electrónico de ese usuario ya está asociado a otra cuenta de Voxy. Es posible que ese usuario ya tenga una cuenta con otra organización.

 

Para resolver este problema, utiliza otra dirección de correo electrónico. Si eso no es conveniente o posible, contacta a tu Customer Success Manager.

 

  • 4. 403 - Forbidden. No puedes acceder a este punto de contacto porque el usuario ha vencido.

 

Si un usuario venció, no podrás solicitar una URL de inicio de sesión único y recibirás una notificación de error 403 - Forbidden. 

 

Se considera que un usuario venció cuando el parámetro expiration_date es anterior al día de la fecha. Por ejemplo, si hoy es 2018-01-05, se considera que el usuario está vencido si el parámetro expiration_date corresponde al 2018-01-04 o antes. 

 

Para actualizar la fecha de vencimiento de un usuario, puedes enviar una solicitud PUT a https://partner-api.voxy.com/partners/users/{external_user_id} e incluir un parámetro de expiration_date con un valor de fecha futuro.

¿Fue útil este artículo?
Usuarios a los que les pareció útil: 0 de 0
¿Tiene más preguntas? Enviar una solicitud

Comentarios

0 comentarios

Inicie sesión para dejar un comentario.