Reportes

REFERENCIA DE API DE REPORTES

v1.0

Fecha de última actualización

9-abril-2024

REFERENCIA DE API DE REPORTES

v1.2

Introducción

Bienvenido al API Unificado de Reportes, puede utilizarlo para obtener diferentes tipos de reportes del Ecosistema apithy.

URL base

Para apuntar el endpoint al ambiente de Sandbox, utilizar:

https://api.stage.apithy.com

Este ambiente de Sandbox tiene un horario de disponibilidad de 14:00 a 00:00 horas UTC.

Para apuntar el endpoint al ambiente de Producción, utilizar:

https://api.apithy.com

Este ambiente de producción no tiene límite de tiempo, está disponible 24x7x365.

Endpoint

/my-reports/last-report

Headers

Headers personalizados que son esperados en la ejecución del API. Favor de notar que RFC7230 especifica que los nombres de los headers son indistintos a mayúsculas y minúsculas.

Nombre	Tipo	Requerido	Descripción
Authorization	String	Sí	Bearer API KEY

Autorización

Usted puede interactuar con el API a través de los métodos de autorización descritos a continuación.

apiKey

Para utilizar el API, tiene que asignarse y obtener su propia llave de API. Las cuentas del API tienen modo pruebas y modo producción. Para cambiar modos, sólo utilice la llave apropiada para obtener el objeto de prueba o producción.

Hay que autenticar sus peticiones al incluir su llave API secreta para el ambiente en vivo o pruebas en el Request header.

• Bearer authorization header: Authorization: Bearer <your-authorization-api-key>

• Application id header: x-apithy-app-id: <your-apithy-app-id>

Debe utilizar las llaves privadas para autenticar las peticiones API.

No comparta ni incluya sus llaves privadas del API en el código del lado del cliente. Sus llaves API contienen privilegios de importancia. Por favor asegúrese de mantenerlas 100% seguras y cerciorarse de no compartir sus llaves secretas de API en áreas que están disponibles públicamente como GitHub.

Parámetros

Nombre	Tipo	Requerido	Descripción	Valores
report_type	string	true	Tipo de reporte a obtener	consumption

Cuerpo de respuesta

Nombre	Tipo	Descripción
success	String	Estado de la operación
data	Object JSON	Resultado de la operación
message	String	Mensaje de error en caso de originarse uno
assignments	Array	Arreglo de datos del reporte
regional_settings	Object JSON	Configuración utilizada para formato de números, fechas y lenguaje del reporte

Códigos de Respuesta posibles

Código	Título	Descripción
200	OK	El mensaje de la solicitud se ha procesado exitosamente, y ha producido una respuesta. El mensaje de respuesta varía, dependiendo del método de la solicitud y los datos requeridos.
400	Bad request	El servidor receptor no puede comprender la solicitud debido a una sintaxis incorrecta. No repetir la solicitud sin antes modificarla; verifique la solicitud en busca de errores, corríjalos y luego vuelva a intentar la solicitud.
401	Unauthorized	La solicitud no se ha aplicado porque carece de credenciales de autenticación válidas para el recurso de destino.
403	Forbidden	No tiene los derechos de usuario adecuados para acceder a la solicitud. No repita la solicitud.
404	Not found	El servidor de origen no encontró una representación actual para el recurso de destino o no está dispuesto a revelar que existe.

Manejo de errores

La API puede producir errores por muchos motivos, como solicitudes fallidas debido a integraciones mal configuradas, parámetros no válidos, errores de autenticación e indisponibilidad de la red.

Ejemplo de respuestas

Todas las respuestas del API son en formato JSON

200:

{

"person_id": 12345,

"person_uuid": "479205eb-...",

"experience_id": 782,

"full_name": "AARON ISRAEL ...",

"email": "[email protected]",

"experience": "Crisis emocionales: ¿Qué son y cómo enfrentarlas? ",

"actual_status": "Experiencia asignada",

"score": 0,

"success": "No",

"used_time": null,

"assigned_at": "2024-03-07 16:23",

"assigned_by_tag": "Si",

"assigned_by_collection": "No",

"collection": "N/A",

"on_time": "N/A",

"tries": "0",

"tags": [

{

"tag_name": "tag 1",

"category": "category A"

},

{

"tag_name": "tag 2",

"category": "category A"

},

{

"tag_name": "tag 1",

"category": "category B"

},

{

"tag_name": "tag 2",

"category": "category B"

}

]

}

400:

{

"success": "error",

"message": "bad_request"

}

403:

{

"success": "error",

"message": "forbidden"

}

404:

{

"success": "error",

"message": "not_found"

}