Belangrijke informatie
Het gebruik van de KampAdmin API is niet standaard inbegrepen in een KampAdmin-licentie. Standaard worden de aanbiedingen op websites weergegeven via Iframe Embeds. Neem contact op met KampAdmin als je gebruik wilt maken van deze API.
Wat is de KampAdmin API V3?
De KampAdmin API stelt je in staat om rechtstreeks gegevens te raadplegen in onze backend. Dit geeft een integrator (bv. een websitebouwer) enorme kracht en flexibiliteit om precies de data op te halen die nodig is en er zelf vormelijk mee aan de slag te gaan.
Standaard is de API alleen-lezen, waardoor je de data op geen enkele manier kunt beschadigen.
Enkel in zeer specifieke gevallen, kan ook toegang tot een schrijf-API worden geboden.
Wat kan je doen met de API?
De KampAdmin API V3 biedt drie soorten endpoints:
Records opvragen: Haal een lijst van records op uit een tabel, met ondersteuning voor filters, sortering en paginering. Dit is het meest gebruikte endpoint voor het tonen van data op een website.
Schema opvragen: Vraag de velddefinities van een tabel op: welke velden beschikbaar zijn, hun type (tekst, getal, keuzelijst, ...), en extra configuratie zoals de beschikbare keuze-opties. Handig voor dynamische integraties die zich automatisch aanpassen aan de veldconfiguratie of voor het verkennen van de API bij opstart.
Afbeeldingen ophalen: Haal afbeeldingen op in een zelfgekozen afmeting op basis van het afbeeldings-ID dat je via het records-endpoint ontvangt.
Hoe snel is het? Moeten we caching voorzien?
Nee, de data wordt slim gecachet. Dit betekent dat een eerste verzoek wat tijd kan kosten, maar daarna zou de gemiddelde responstijd onder de 50 ms moeten liggen. Het toevoegen van een extra cachelaag of het lokaal opslaan van data kan overwogen worden, maar zal waarschijnlijk veel complexiteit toevoegen zonder veel prestatiewinst.
Onze servers bevinden zich in het Amazon-datacenter in Ierland. Als je minimale latentie voor jouw verzoeken nodig hebt, kun je overwegen om jouw servers ook daar te plaatsen.
Toegang tot de API
Toegang tot de API wordt geregeld door unieke tokens die per tabel worden verstrekt en afhankelijk zijn van specifieke instellingen.
Tokens via KampAdmin
Het KampAdmin-team kan je deze tokens bezorgen, of op verzoek deze token roteren. Indien je API toegang nodig hebt tot een nieuwe tabel, verloopt dit ook steeds eerst via KampAdmin.
Verder moet per kolom/veld worden ingesteld of die in de API kan gebruikt worden, we werken daarbij met een opt-in methode waarbij enkel kolommen worden aangereikt die werden geactiveerd door KampAdmin of de beheerder bij de organisatie.
Extra gegevens nodig als integrator?
Contacteer dan de beheerder bij de organisatie.
Limieten
API-limieten worden indien nodig per integratie besproken.
Voor meer informatie, kan je steeds mailen naar info@kampadmin.be .