iDDi UAN
API pública para consulta de perfil y catálogos de la Plataforma iDDi. Esta API puede ser usada por cualquier desarrollador que requiera verificar el estatus del perfil de un QR de Identidad Universitaria.
La API es RESTful, tiene URLs de recursos predecibles. Devuelve códigos de respuesta HTTP para indicar errores. También acepta y devuelve JSON en el cuerpo HTTP. Puedes usar tu biblioteca HTTP / REST de cualquier lenguaje de programación, o puedes usar uno de los SDK de iDDi (actualmente disponible en PHP y Javascript).
Esta referencia de API proporciona información sobre los endpoints disponibles y cómo interactuar con ellos. Para obtener más información sobre la API, consulta https://iddi.uan.mx/docs/documentacion-tecnica/uso-de-la-api.html.
Cuando un desarrollador se registra para obtener acceso a la API de iDDi, se le otorga su primera clave de API secreta (API-Key). Se pueden generar claves API adicionales y eliminar claves API (ya que se puede necesitar rotar las claves en el futuro). Se autentica en la API proporcionando la clave en el encabezado de la solicitud.
Para consultar la API se pueden utilizar dos formas de autenticación: API-Key y AccessToken en forma de JWT (JSON Web Tokens).
Nunca se deben compartir las claves secretas. Se deben mantener vigiladas y seguras.
Se puede crear un AccessToken dentro de la página de Desarrolladores, que se encuentra aquí: https://developers.iddi.uan.mx/account/api-keys
Los AccessToken caducan en máximo 3 meses. Esto es para limitar los riesgos asociados con los sistemas que se ejecutan sin ser monitoreados.
Para más información, consultar la documentación sobre el uso de la API: https://iddi.uan.mx/docs/documentacion-tecnica/uso-de-la-api.html#seguridad
Para todos los métodos que devuelven más de un solo objeto, proporcionamos paginación. Se puede usar enviando los siguientes parámetros de consulta.
| Atributo | Tipo | Descripción |
|---|---|---|
limit |
Integer | El número total de objetos que se deben devolver. El valor predeterminado es 50. Tiene un máximo de 500. |
page |
Integer | Desplazamiento de página actual. Aumentar este número multiplicará por limit. Por defecto es 1. |
Para garantizar que la experiencia de uso de la API sea rápida para todos los clientes, implementamos el Rate Limit. Si se llega a los límites permitidos, se presentará un mensaje de error. Si el sistema cliente necesita aumentar los límites para un caso específico, se debe contactar a la Secretaría de Docencia.
La API utiliza códigos de respuesta HTTP para indicar el éxito o el fallo de una solicitud. Los códigos dentro del rango 2xx (success) se consideran peticiones completadas con éxito. Los códigos dentro de los rangos 4xx (fail) y 5xx (error) indicarán que se ha producido un error.
Utilizamos los siguientes códigos HTTP para gestionar los errores comunes.
| Código de error | Significado |
|---|---|
| 400 | Solicitud incorrecta: se ha pasado una solicitud con formato incorrecto. |
| 401 | No autorizado: compruebe cabecera Autorization. El Bearer token proporcionado no es válido. |
| 403 | Prohibido: su API-Key no puede acceder a este recurso |
| 404 | No encontrado: no se pudo encontrar el recurso especificado. |
| 405 | Método no permitido: intentó acceder a un endpoint con un método no válido. |
| 406 | No aceptable: solicitud con un formato json inválido. |
| 422 | Entidad no procesable: hay un problema de validación con la solicitud. Se proporcionan los campos y mensajes de error dentro de la respuesta. |
| 429 | Demasiadas solicitudes: la tasa de envío de mensajes es demasiado rápida. Recomendamos ralentizar sus solicitudes. |
| 500, 502, 503, 504 | Hay un problema con el servidor. Estos son raros y se enviará un mensaje sobre el error. |
Perfil básico, estatus escolar/administrativo, estatus de la iDentidad Digital del Usuario. QR, vigencia y estatus de iDDi movil.
Servidor productivo principal.
Pruebas para consultas (stagging).
MockServer - Prism
Obtiene el Perfil básico del usuario y su estatus usando el folio de la credencial.
Es neccesario enviar como parámetro además del folio, la firma digital del QR para certificar que es un folio de una credencial emitida por iDDi.
Para solicitar el Perfil extendido se requiere el scope perfil:extendido en el Access Token
perfilperfil:extendido) | folio required | string Folio de la credencial |
| perfil_extendido | boolean Solicita el perfil extendido de esta credencial. Requiere scope |
| firma_digital required | string EL componente de firma digital (último campo) del QR de una Credencial |
Success
ID proporcionado inválido
No autorizado
Recurso no encontrado
Excepción de validación
Hubo un problema al procesar tu solicitud, por favor inténtalo de nuevo o inténtalo más tarde.
