Aan de slag met onze REST API

Welkom bij onze REST-API! Deze handleiding biedt een kort overzicht om u op weg te helpen met het integreren van onze API in uw applicaties.

Uw API-sleutel instellen

  1. Verkrijg uw API-sleutel: log in op de applicatie, navigeer naar de instellingen en zoek de API-sectie. Kopieer uw API-sleutel.
  2. Authenticatie: Om uw verzoeken te authenticeren, voegt u de API-sleutel toe als een Bearer-token in de header van elk verzoek.
  • Formaat: Autorisatie: {API_KEY}

Understanding pagination

Onze API maakt gebruik van paginering om grote sets gegevens efficiënt te beheren.

  • Basisconcepten: In plaats van alle records in één keer terug te sturen, worden de gegevens bij paginering opgedeeld in ‘pagina’s’ met een opgegeven aantal records per pagina.
  • Parameters:
  • pagina: Het huidige paginanummer dat u bezoekt.
  • page_size: Het aantal records per pagina.
  • Paginering gebruiken: Wanneer u eindpunten opvraagt die meerdere items retourneren (zoals lijsten of gebeurtenissen), gebruikt u deze parameters om door uw gegevens te navigeren.

Webhooks

Met webhooks kunt u realtime updates ontvangen voor specifieke gebeurtenissen in uw systeem.

  • Installatie: geef een webhook-URL en een geheim token op in de applicatie-instellingen. Deze URL is waar de applicatie updates naartoe zal sturen.
  • Updates ontvangen: wanneer er een gebeurtenis plaatsvindt, stuurt ons systeem een POST-verzoek naar uw webhook-URL met relevante gegevens.

Voorbeelden van gebruiksscenario’s

  1. Gegevens ophalen met paginering:
  • Om de derde pagina van een lijst met 10 records per pagina te krijgen, zou u een verzoek indienen bij een eindpunt zoals /lists?page=3&page_size=10.
  1. Gegevens bijwerken:
  • Gebruik het relevante PUT- of POST-eindpunt, voeg het Bearer-token toe voor authenticatie en verzend uw update-payload.

Verdere hulp krijgen

  • Documentatie: Raadpleeg voor gedetailleerde informatie onze API-documentatie die beschikbaar is in de Redoc- en Postman-collecties.
  • Ondersteuning: Als u problemen ondervindt of vragen heeft, kunt u contact opnemen met ons ondersteuningsteam.

Deze handleiding is bedoeld om u de nodige hulpmiddelen te bieden om snel met onze API te kunnen communiceren. Duik erin en ontdek de verschillende functies en mogelijkheden die tot uw beschikking staan!

Resources

  • U kunt de Postman-collectie hier downloaden.
  • Lees hier de API-referentie.
  • Download de WordPress plugin via deze link.
  • Als u vragen heeft, staan wij klaar om u te helpen! Klik hier om ondersteuning te krijgen.