Overslaan naar inhoud
Het supportcentrum van BIQSDRIVE Naar www.biqsdrive.com

API-toegang voor je website

Met Instellingen › API-toegang (/settings/api-access) kan je website, of het bureau dat die bouwt, je opleidingen, cursussen met hun data, locaties en rijbewijscategorieën tonen, altijd up-to-date. Elke website krijgt een eigen koppeling met een client-id en een geheim. Een koppeling ziet alleen wat dit bedrijf aanbiedt: je gepubliceerde pakketten en de open cursussen die nog moeten beginnen. Ze ziet nooit klanten, instructeurs of iets anders.

Hoe koppel ik een website?

  1. Open Instellingen › API-toegang. Met meer dan één bedrijf kies je eerst het Bedrijf.
  2. Klik op Nieuwe koppeling, geef ze een naam (bijvoorbeeld "Website rijschool") en klik op Opslaan.
  3. Kopieer de Client-id en het Geheim en geef ze aan wie je website beheert, samen met het Token-adres en het API-adres die op de pagina staan. Het geheim wordt maar één keer getoond.
  4. Klik op Ik heb het bewaard.

Je webontwikkelaar gebruikt de standaard OAuth 2.0-flow client credentials: de website vraagt een token op bij het token-adres met de client-id en het geheim, en leest daarna de catalogus op het API-adres. Het geheim hoort op de server van de website, nooit in de webpagina zelf.

Wat ziet de website?

  • Opleidingen: de actieve producten waarvoor Online publiceren aanstaat (geen kosten), met hun prijs inclusief btw.
  • Cursussen: open en volzette cursussen die nog moeten beginnen, met hun sessies, locatie en resterende plaatsen. Een volzette cursus wordt als volzet getoond. Alleen cursussen waarvan het pakket Online publiceren aan heeft, verschijnen, zodat interne of bedrijfscursussen van je website wegblijven.
  • Locaties en rijbewijscategorieën (alleen de actieve; een uitgeschakelde categorie wordt niet meer getoond, ook niet bij een cursus).

Om te wijzigen wat er verschijnt, wijzig je het product (Online publiceren) of de cursus, zoals je dat doet voor de inschrijvingswizard.

Hoe stop ik een website, of wijzig ik het geheim?

  • Nieuw geheim (de ronde pijl): het oude geheim en alles wat ermee uitgereikt werd, werken meteen niet meer. Geef het nieuwe geheim aan de website.
  • Uitschakelen (de pauzeknop): de koppeling stopt meteen, en alles wat eerder uitgereikt werd, blijft ongeldig; schakel ze later weer in met de afspeelknop. De website meldt dan opnieuw aan met dezelfde client-id en hetzelfde geheim.
  • Verwijderen (de vuilnisbak): de koppeling wordt definitief verwijderd.

Elke nieuwe koppeling, elk nieuw geheim, elke naamswijziging, elke uit- of inschakeling en elke verwijdering staat onder Historiek onderaan de pagina, met wie het deed en wanneer; een verwijderde koppeling blijft daar staan.

Doe dit meteen als een geheim mogelijk uitgelekt is of als je van webbureau verandert.

Goed om te weten

  • Als je licentie verlopen is, stopt de koppeling: de website krijgt geen token of gegevens meer (melding license_expired) tot de licentie verlengd is. Op de website hoeft niets gewijzigd te worden.
  • Alleen gebruikers van wie de rol API-toegang voor websites beheren heeft, zien deze pagina; de standaardrol Beheerder heeft het. De pagina vereist verificatie in twee stappen.
  • Laatst gebruikt toont wanneer de website het laatst aanmeldde.
  • Een bedrijf kan hoogstens 10 koppelingen hebben.

(Nog) niet mogelijk

  • Vanaf de website rechtstreeks naar een opleiding of cursus in de inschrijvingswizard linken.
  • Een website inschrijvingen of vragen laten versturen via de API.

Niet gevonden wat je zocht?

Ticket indienen