Documentación API

absence.io ofrece una API RESTful, con la que se puede recuperar, crear, actualizar o eliminar la mayoría de los "entites" de ausencia. 

Todas las URL de la API están debajo de la ruta URL: https://app.absence.io/api/v2/[....]

La API de absence.io sólo admite el formato JSON para enviar y recuperar datos. 

 

Introducción

Haz clic aquí para crear tus propios plugins de absence.io o integrar absence.io en sistemas personalizados. 

 

Autentificación

Para utilizar la API de absence.io necesitarás una clave API. Para generar una, ves al perfil de tu cuenta de absence.io, haz clic en la pestaña "Integraciones" y clica en el botón "Generar clave API". 

La clave API consta de dos partes:

  • El identificador de clave (id) utilizado para identificar tu clave.
  • La clave actual.

Para transmitir tu clave API usamos Hawk. Haz clic aquí para aprender más.

 

Conceptos generales

Aquí puedes encontrar una descripción general de nuestra API y sus funciones. 

 

Códigos de respuesta HTTP 

Haz clic aquí para obtener más información sobre los códigos de respuesta que puedes necesitar al enviar solicitudes a la API.

 

Consultar objetos

Todas las peticiones respetan un formato que puedes encontrar aquí con más detalle.

 

Respuesta

Mediante las relaciones puedes indicar al servicio que resuelva las propiedades de ID a sus respectivos objetos. 

Al agregar una matriz de relaciones al cuerpo de la solicitud, le indica al servidor que cargue el objeto completo para la propiedad ID de la entidad principal. 

Por ejemplo, para resolver el assignedToId a una propiedad llamada assignedTo utiliza la siguiente sintaxis:

 

Request
POST http://localhost:3000/api/v2/absences
{ 
    "filter": {
            "start": {"$lte" : "2015-12-20T00:00:00.000Z"},
            "end": {"$gte": "2015-12-31T00:00:00.000Z"}
    },
    relations:['assignedToId']
}

 

Response
{
  "skip": 0,
  "limit": 50,
  "count": 50,
  "totalCount": 458,
  "data": [
    {
      "_id": "5480402809650202004df75b",
      "modified": "2014-12-06T10:04:39.006Z",
      "created": "2014-12-04T11:06:16.471Z",
      "start": "2014-12-03T00:00:00.000Z",
      "end": "2014-12-08T00:00:00.000Z",
      "assignedToId": "63ec876edf869a0200707ac3",
      "assignedTo": {
        "_id": "63ec876edf869a0200707ac3",   
        "email": "absence.owner@gmail.com",
        "lastName": "Lebbe",
        "firstName": "Christina",      
     ...
     ...

}

 

Más

Puedes encontrar información específica y más ejemplos sobre cada entidad aquí.

 

¡Que pases un buen día!

 

Tu equipo de absence.io 

¿Fue útil este artículo? Usuarios a los que les pareció útil: 0 de 0