# Inicio

A continuación se describirá el consumo correcto de la API de Consulta.

# 📖 Información general

Es necesario mencionar que este es un servicio REST y se consume a traves de un cliente HTTP. Esta pensado para utilizarse sobre un Backend, no se recomienda consumir directamente en Javascript sobre el navegador debido a tema de CORS (opens new window).
La autenticación a la API se realiza mediante el uso de una API Key la cual se debe enviar en Header del Request HTTP. El Header debe llamarse x-api-key.
La API Key tiene una longitud de 48 caracteres hexadecimales.
En caso de decidirse por adquirir el servicio puede ver nuestros paquetes y precios en el siguiente enlace: https://consultaunica.mx/#prices (opens new window)
Después de la compra estará recibiendo un correo con su API Key. Si pasan mas de 30 minutos desde su compra y no la ha recibido favor de comunicarse con nosotros mediante alguno de los medios disponibles descritos abajo.
La URL base para consumir los servicios de la API es: https://consultaunica.mx/api/v3/{service_name} mediante el método POST.
Se incluyen ejemplos avanzados de consumo en la documentación que tenemos para Postman: https://bit.ly/cu-docs-pm (opens new window)

En caso de problemas o cualquier tema que quiera tratar, contamos con 3 medios de contacto disponibles:

Servicio	Utilidad
IMSS	Mediante una CURP y correo electrónico se puede consultar el NSS de una persona. Una segunda llamada puede devolver la constancia de vigencia de derechos y una tercer llamada puede devolver el documento de semanas cotizadas.
Afore	Con una CURP se consulta si se cuenta con Afore así como su nombre y medios para ponerse en contacto.
SAT	Mediante un RFC unicamente verifica si este RFC es válido ante el SAT. Atención: no devuelve ningún documento ni información personal. También es posible localizar el nombre fiscal de una persona fisica o moral con su RFC. Es posible validar que el nombre del contribuyente, su RFC y su código postal sean los mismos que los que tiene el SAT. Así como localizar un RFC de una persona fisica dado su nombre completo y fecha de nacimiento.
Ifetel	Con un número de teléfono de 10 digitos devolverá que tipo de teléfono es (fijo o móvil), la compañía teléfonica, la lada y la ciudad de registro
Estudios	Con el nombre completo o parcial de una persona verifica si esta cuenta con una cedula profesional registrada ante el Registro Nacional de Profesionistas. Atención: no devuelve ningún documento

Códigos de respuesta que devuelven los endpoints de consumo:

Código	Descripción	Descuenta un uso de API
`200`	✅ Todo estuvo bien, se devuelve contenido de la consulta	Si
`409`	❌ Pre validación: error con alguno de los datos ingresados	No
`404`	❌ No se encontró el servicio	No
`429`	❌ Limite alcanzado, se acabaron los usos de la API	No
`400`	❌ Validación de servicio externo: error con los datos ingresados	No
`422`	❌ Error conocido de un servicio externo	No
`500`	❌ Error desconocido de un servicio externo	No

Los errores 4xx y 5xx devuelven un JSON con la siguiente estructura:

{
  "message": "Mensaje describiendo el error"
}