Public API Webhooks is een nieuwe dienst waarmee je notificaties kunt ontvangen over wijzigingen in je account, waardoor je niet meer voortdurend de Rentman Public API hoeft te gebruiken.

Webhooks zijn simpelweg URL's die door Rentman worden aangeroepen wanneer er iets in je account wordt toegevoegd, gewijzigd of verwijderd.

Je kan het zien als een pushmelding voor elke gebeurtenis in je account, of het nu gaat om het toevoegen van een nieuw project, het bewerken van een contactpersoon of het verwijderen van een exemplaar. Wanneer een van deze gebeurtenissen plaatsvindt, zal Rentman een payload posten op de ingestelde URL. Deze payload bevat details over de toegevoegde, gewijzigde of verwijderde onderdeel, samen met tips over hoe je meer informatie uit de openbare API ophaalt.

Let op: Het gebruik van webhooks vereist technische programmeervaardigheden en ervaring. Bezit je niet over deze vaardigheden, dan adviseren we om hulp te zoeken bij een externe ontwikkelaar of bedrijf. Houd er rekening mee dat ons support team niet is opgeleid op dit gebied en geen hulp kan bieden bij de implementatie van de webhook.

Openbare API-Webhooks instellen

1. Ga naar de Configuratiemodule en selecteer "Extensies" om webhooks te activeren
2. Scroll naar de Webhooks sectie en klik op "Verbinden"
3. Onderstaande pop-up verschijnt:
   
   Hier geef je de URL op en krijg je een token. In het URL-veld specificeer je welke URL door Rentman wordt aangeroepen als er iets in je account wordt aangemaakt, gewijzigd of verwijderd. Het token zal in plaats daarvan worden gebruikt voor het genereren van een samenvatting die aan de clientzijde moet worden gebruikt om te verifiëren dat het bericht afkomstig is van Rentman.
4. Klik op “Opslaan” en sluit het pop-upscherm om Webhooks te activeren

Openbare API-Webhooks beheren

Heb je alle bovenstaande stappen gevolgd? Dan zal Rentman, wanneer er iets wordt toegevoegd, gewijzigd of verwijderd in je account, de opgegeven URL aanroepen. In dit geval worden berichten verzonden naar https://mywebhookurl.com. 

Elk bericht volgt dezelfde indeling. Voor nieuwe aanmaken of updates zien berichten er als volgt uit:

{
  "account": "youraccountname",
  "user": { 
    "itemType": "Crew",
    "id": 33,
    "ref": "/crew/33"
  },
  "eventType": "create", 
  "itemType": "Contact", 
  "items": [ 
    {
        "id": 12014,
        "ref": "/contacts/12014",
        "parent": null
    }
  ],
  "eventDate": "2023-02-02T12:07:01+01:00"
}

{
  "account": "youraccountname",
  "user": {
      "itemType": "Crew",
      "id": 33,
      "ref": "/crew/33"
  },
  "eventType": "update",
  "itemType": "SerialNumber",
  "items": [
    {
        "id": 8367,
        "ref": "/serialnumbers/8367",
        "parent": {
            "id": 12792,
            "itemType": "Equipment",
            "ref": "/equipment/12792"
        }
    }
  ],
  "eventDate": "2023-02-02T12:03:25+01:00"
}

{
  "account": "youraccountname",
  "user": {
      "itemType": "Crew",
      "id": 33,
      "ref": "/crew/33"
  },
  "eventType": "delete",
  "itemType": "ContactPerson",
  "items": [
      10,
      31
  ],
  "eventDate": "2023-02-02T12:08:00+01:00"
}

/* example what a Digest header looks:
Digest: sha512=509072eee2c11804287bf807307ed360892053dde89c15ddacd9daa24c63c492963c089d54677598df4422f7d18cbd6a8ebca689841754e8ca44aee1054ddf0c
*/

// this is the full request body
$raw_body = file_get_contents('php://input');

//split value on '='
$digestParts = explode('=', $_SERVER['HTTP_DIGEST']);
$algo = digestParts[0];
$digest = digestParts[1];

// This is known by the client and Rentman only
$token= 'some_secret_key';
$clientGeneratedDigest = hash_hmac($algo, $raw_body, $token, false);

if($digest === $clientGeneratedDigest){
// The webhook call was made by Rentman
}
else{
// The webhook call was not made by Rentman
}

Wat moet ik doen als webhook-URL's niet meer reageren?

Rentman heeft een meldingssysteem geïmplementeerd voor wanneer webhook-URL's niet meer reageren vanwwege een onjuiste instelling of problemen met het eindpunt.

Wat houden deze meldingen in:

Deze meldingen zijn alleen zichtbaar voor medewerkers met toegang tot de settingsConfiguratiemodule. Zorg ervoor dat de juiste medewerkers toegang hebben tot deze module, zodat ze op de hoogte blijven en eventuele problemen snel op kunnen lossen.

Los problemen op door webhooks opnieuw in te schakelen. Werk de URL bij in het gedeelte Webhooks in de settings Configuratiemodule, net zoals je dat doet wanneer je webhooks voor het eerst inschakelt.

[GIF here]

Rentman Tip: Geef een geldige en werkende URL op om een ​​ononderbroken levering van de webhook te garanderen.