Met de API en webhooks koppel je je salon aan andere software, zoals je boekhoudpakket, een eigen website of een zelfgebouwd dashboard. Je hoeft geen developer te zijn om te begrijpen wat ze doen; deze pagina legt het uit en laat zien hoe je een sleutel en een webhook aanmaakt.
Deze functie staat in de app nog op Binnenkort beschikbaar: je kunt op dit moment geen API-sleutels of webhooks aanmaken. Open je Instellingen > Geavanceerd > API & Webhooks, dan zie je alleen een melding dat de functie eraan komt. Deze pagina beschrijft hoe het werkt zodra de functie voor je salon aan staat.
Wat is een API?
Een API is een afspraak waarmee twee programma's met elkaar praten. Waar jij in de app een lijst afspraken opent, kan een ander programma diezelfde gegevens via de API ophalen, automatisch en zonder tussenkomst. Bijvoorbeeld: je boekhoudprogramma haalt elke nacht je afspraken op, of je website toont je behandelingen en prijzen rechtstreeks uit Salonnare.
Toegang loopt via een API-sleutel: een geheime code die bewijst dat een aanvraag van jouw salon komt. Behandel die sleutel als een wachtwoord.
Een API-sleutel aanmaken
Alleen een beheerder kan sleutels aanmaken en verwijderen.
-
Stap 1: Open API & Webhooks en klik op Nieuwe sleutel
Ga naar Instellingen > Geavanceerd > API & Webhooks. Op het tabblad API-sleutels (1) klik je op Nieuwe sleutel (2).
(Afbeelding vergroten) -
Stap 2: Geef de sleutel een naam en kies wat hij mag lezen
Vul een herkenbare Naam in, bijvoorbeeld de naam van de koppeling (1). Vink bij Wat mag deze sleutel lezen? alleen de gegevens aan die de koppeling nodig heeft (2): Afspraken, Klanten, Behandelingen of Medewerkers. Wil je dat de sleutel na een bepaalde dag stopt, kies dan bij Verloopt een datum. Klik op Aanmaken (3).
Een API-sleutel kan alleen gegevens ophalen, nooit iets wijzigen. Klanten zijn persoonsgegevens: zet dat alleen aan als je koppelpartij ze echt nodig heeft. Een website die je behandelingen en prijzen toont heeft genoeg aan Behandelingen en Medewerkers.
(Afbeelding vergroten) -
Stap 3: Kopieer de sleutel
De volledige sleutel (1) wordt maar één keer getoond. Klik op de kopieerknop (2) en geef de sleutel door aan je koppelpartij, of bewaar hem in een wachtwoordkluis. Sluit daarna het venster.
(Afbeelding vergroten) -
Stap 4: Je sleutel in de lijst
In de lijst zie je de naam, het begin van de sleutel, wat hij mag lezen, wanneer hij voor het laatst is gebruikt en wanneer hij verloopt (1). Met Vernieuwen (2) krijg je een nieuwe sleutel met dezelfde naam en rechten; je kiest hoe lang de oude nog werkt (meteen niet meer, 24 uur of 7 dagen), zodat je koppelpartij tijd heeft om over te stappen. Met Intrekken (3) stopt een sleutel meteen.
(Afbeelding vergroten)
Wat is een webhook?
Een webhook is het omgekeerde van de API. In plaats van dat een programma steeds vraagt of er iets nieuws is, stuurt Salonnare zelf een bericht naar een adres (URL) zodra er iets gebeurt. Salonnare kan deze zeven gebeurtenissen sturen:
booking.created: er komt een nieuwe afspraak bij: in de app, via je online boekingspagina of widget, via Google Reserve, of zodra een boekingsaanvraag is bevestigd (ook elke afspraak die een herhalende reeks aanmaakt)booking.updated: een medewerker wijzigt een afspraak in de app (ook een statuswijziging naar voltooid of no-show)booking.cancelled: een medewerker annuleert een afspraak in de apppayment.received: een medewerker rekent af in de kassaclient.created: een medewerker maakt een klant aan in de appclient.updated: een medewerker wijzigt klantgegevens in de appclient.deleted: een medewerker verwijdert een klant in de app. De melding bevat alleen het klantnummer; eerdere meldingen over die klant bewaart Salonnare daarna zonder naam en contactgegevens
Elke gebeurtenis komt uit een handeling van een medewerker in de app. Een online boeking via je boekingspagina of Google, een klant die zelf annuleert, een wachtlijst die wordt omgezet, een herhalende reeks, een kuur en een klant die zichzelf op de boekingspagina aanmaakt sturen geen melding. Je koppelpartij vangt die op door regelmatig de afsprakenlijst op te halen.
Een webhook instellen
-
Stap 1: Open het tabblad Webhooks
Ga naar Instellingen > Geavanceerd > API & Webhooks en klik op het tabblad Webhooks.
(Afbeelding vergroten) -
Stap 2: Klik op Nieuwe webhook
Klik op Nieuwe webhook.
(Afbeelding vergroten) -
Stap 3: Vul het adres in en kies de gebeurtenissen
Vul bij URL het adres in dat je van je koppelpartij kreeg; het begint met
https://(1). Vink de gebeurtenissen aan waarop de koppeling moet reageren (2 en 3). Actief staat standaard aan. Klik op Opslaan (4).
(Afbeelding vergroten) -
Stap 4: Kopieer het geheim
Salonnare ondertekent elk bericht met een geheim, zodat de ontvanger kan controleren dat het echt van jouw salon komt. Het geheim (1) wordt maar één keer getoond: kopieer het (2) en geef het door aan je koppelpartij.
(Afbeelding vergroten) -
Stap 5: Testen en de meldingen bekijken
De webhook staat nu in de lijst (1). Met Test (3) stuurt Salonnare meteen een testbericht en zie je of het aankwam. Onder Meldingen (4) zie je elke melding met de stand (aangekomen, wordt opnieuw geprobeerd of mislukt) en de pogingen; een mislukte melding stuur je daar opnieuw met Opnieuw versturen. Ben je het geheim kwijt, klik dan op Nieuw geheim (2); het oude werkt daarna niet meer, dus de ontvangende kant moet ook worden bijgewerkt.
(Afbeelding vergroten)
Wat als ...
... de test niet aankomt? Dan meldt Salonnare dat het adres niet reageerde of welke foutcode de ontvanger teruggaf. Controleer het adres, en vraag je koppelpartij te kijken waarom hun kant het bericht weigert.
... een melding een keer niet aankomt? Salonnare probeert het dan opnieuw: na ongeveer 1 minuut, 5 minuten, 30 minuten, 2 uur, 8 uur en 24 uur. Elke poging draagt hetzelfde meldingsnummer, zodat de ontvanger een melding die twee keer binnenkomt herkent. Lukt geen enkele poging en kwam er in die tijd ook niets anders aan, dan zet Salonnare de webhook uit en krijg je daar een melding van. Je zet hem weer aan door hem te bewerken en Actief aan te zetten. Mislukte meldingen stuur je opnieuw onder Meldingen met Opnieuw versturen.
... het adres wordt geweigerd? Een webhook moet naar een openbaar adres wijzen. Adressen in een intern of privé netwerk, localhost en adressen die niet met https:// beginnen weigert Salonnare, met een melding die zegt wat er mis is.
... je vermoedt dat een sleutel is uitgelekt? Verwijder hem meteen met de prullenbak en maak een nieuwe aan.
Veilig werken
- Deel API-sleutels en webhookgeheimen nooit publiek (niet in een gewone e-mail, op een screenshot of in code die online staat).
- Geef een koppeling alleen de rechten die ze nodig heeft.
- Verwijder sleutels en webhooks die je niet meer gebruikt.
Ben je developer en zoek je de technische details (authenticatie, endpoints, velden, handtekeningen)? Bekijk de API Reference. Die pagina is in het Engels, omdat hij voor ontwikkelaars is geschreven.