Los Webhooks de la API pública son un servicio que te permite recibir notificaciones sobre cambios en tu cuenta, eliminando la necesidad de hacer consultas constantes a través de la API pública de Rentman.

En esencia, los webhooks son simplemente URLs a los que Rentman llama cada vez que se agrega, cambia o elimina algo en tu cuenta.

Piensa en ellos como notificaciones push para cada evento en tu cuenta, ya sea la adición de un nuevo proyecto, la edición de un contacto o la eliminación de un número de serie. Cuando ocurre alguno de estos eventos, Rentman enviará un payload a la URL que hayas establecido. Este payload contiene detalles sobre la entidad agregada, modificada o eliminada, junto con pistas sobre cómo recuperar más información de la API pública.

Nota: Utilizar webhooks requiere habilidades técnicas de programación y experiencia. Si te faltan estas habilidades, te recomendamos buscar ayuda de un desarrollador externo o una empresa. Ten en cuenta que nuestro equipo de soporte no está capacitado en este campo y no puede brindar asistencia con la implementación de webhooks.

Configuración de Webhooks de la API pública

1. Para habilitar los webhooks, ve al módulo de Configuración y selecciona "Extensiones"
2. Desplázate hacia abajo hasta la sección de Webhooks y haz clic en “Conectar”
3. Aparecerá este pop-up:Aquí necesitas especificar URL y se te proporciona un Token. El campo de URL es donde especificas qué URL llamará Rentman cuando se cree, modifique o elimine algo en tu cuenta. El Token, en cambio, se utilizará para generar un resumen que deberá usarse del lado del cliente para verificar que el mensaje proviene de Rentman.
4. Haz clic en “Guardar” y cierra el pop-up para habilitar los Webhooks.

Dominando los Webhooks de la API pública

Después de seguir todos los pasos anteriores, cuando se añade, modifica o elimina algo en tu cuenta, Rentman hará una llamada a la URL especificada. En este caso, se enviarán mensajes a https://mywebhookurl.com. 

Cada mensaje sigue un formato común. Para creaciones o actualizaciones, los mensajes se verán así:

{
  "cuenta": "nombredecuenta",
  "usuario": { 
    "tipoDeElemento": "Equipo",
    "id": 33,
    "ref": "/equipo/33"
  },
  "tipoDeEvento": "crear", 
  "tipoDeElemento": "Contacto", 
  "elementos": [ 
    {
        "id": 12014,
        "ref": "/contactos/12014",
        "padre": null
    }
  ],
  "fechaDeEvento": "2023-02-02T12:07:01+01:00"
}

{
  "cuenta": "nombredecuenta",
  "usuario": {
      "tipoDeElemento": "Equipo",
      "id": 33,
      "ref": "/equipo/33"
  },
  "tipoDeEvento": "actualizar",
  "tipoDeElemento": "NúmeroDeSerie",
  "elementos": [
    {
        "id": 8367,
        "ref": "/numerosdeserie/8367",
        "padre": {
            "id": 12792,
            "tipoDeElemento": "Equipo",
            "ref": "/equipo/12792"
        }
    }
  ],
  "fechaDeEvento": "2023-02-02T12:03:25+01:00"
}

{
  "cuenta": "nombredecuenta",
  "usuario": {
      "tipoDeElemento": "Equipo",
      "id": 33,
      "ref": "/equipo/33"
  },
  "tipoDeEvento": "eliminar",
  "tipoDeElemento": "PersonaDeContacto",
  "elementos": [
      10,
      31
  ],
  "fechaDeEvento": "2023-02-02T12:08:00+01:00"
}

/* ejemplo de cómo se ve un encabezado de Digest:
Digest: sha512=509072eee2c11804287bf807307ed360892053dde89c15ddacd9daa24c63c492963c089d54677598df4422f7d18cbd6a8ebca689841754e8ca44aee1054ddf0c
*/

// este es el cuerpo completo de la solicitud
$raw_body = file_get_contents('php://input');

// dividir el valor en '='
$digestParts = explode('=', $_SERVER['HTTP_DIGEST']);
$algo = digestParts[0];
$digest = digestParts[1];

// Esto es conocido por el cliente y Rentman solamente
$token= 'some_secret_key';
$clientGeneratedDigest = hash_hmac($algo, $raw_body, $token, false);

if($digest === $clientGeneratedDigest){
// La llamada de webhook fue realizada por Rentman
}
else{
// La llamada de webhook no fue realizada por Rentman
}