Overslaan naar inhoud
Nederlands
Contact
  • Er zijn geen suggesties want het zoekveld is leeg.

KYP API - Questions & Answers

Inhoudsopgave

API-connectie & documentatie

OpenAPI koppeling opzetten

Om data uit KYP op te halen via onze OpenAPI, volg je deze 4 stappen:

  1. Maak een integratiegebruiker aan via KYP (via support of beheer)

  2. Laat per project waarin je data wilt ontsluiten, de integratiegebruiker toevoegen als Projectmanager

  3. Ga naar https://kyp.nl/rest/login/api en log in met de integratiegebruiker

  4. In de URL van je browser verschijnt het veld access_token
    ➡️ Deze token gebruik je om gegevens op te halen via de API

💬 Opmerking: De token wordt direct na goedkeuring getoond in de URL, dus zorg dat je deze veilig opslaat.

        API-documentatie

        Gedetailleerde documentatie is beschikbaar via Swagger:

        💡 Tip: Onderaan de Swagger-pagina staan de data-modellen uitgewerkt. Je kunt hier ook live endpoints testen.

        Authenticatie en toegang

        💬 Opmerking: Zorg dat je de integratiegebruiker in beide omgevingen toegang geeft waar nodig.

        Datastromen en Endpoints

        Beschikbare endpoints

        Je vindt een overzicht van alle beschikbare endpoints voor zowel read als write functies in Swagger.

        Real-time of batch?

        De API werkt real-time, maar ondersteunt ook batch-verwerking.

        ⚠️ Waarschuwing: Bij grote volumes of frequent batch-calls kunnen piekmomenten de stabiliteit beïnvloeden. Stem dit vooraf met ons af.

        Webhook beschikbaar?

        Er is geen webhookfunctionaliteit aanwezig.
        Er worden momenteel enkel e-mailnotificaties verstuurd.

        Integratie met ons huidige systeem

        • Voorbeeldcode of SDK beschikbaar? Nog niet

        • Bidirectioneel? Ja, je kunt zowel data ophalen als wegschrijven

        💬 Opmerking: Wij vernemen graag van tevoren op welke manier je de integratie wilt opzetten. Zo kunnen we meedenken over de technische haalbaarheid.

        Limieten en prestaties

        Rate limits

        Er is geen vaste limiet, maar we vragen om vooraf aan te geven hoeveel API-calls je verwacht:

        • Aantal aanroepen per uur/dag

        • Verwachte belasting (batch of realtime)

        Op basis daarvan stemmen we af wat haalbaar is.

        Responstijd

        • Gemiddeld: 126,2 ms

        • Uitschieters: enkele gevallen tot 1 minuut, afhankelijk van de specifieke call

        Onderhoud en updates

        Hoe worden wijzigingen doorgegeven?

        Wijzigingen in endpoints of structuur worden vooraf gecommuniceerd met partijen die gebruikmaken van de API.

        • Updates verlopen stapsgewijs

        • Je krijgt tijdig de gelegenheid om aanpassingen door te voeren

        Is er een changelog of roadmap?

        Er is op dit moment geen openbare roadmap beschikbaar.

        Support en SLA

        Ondersteuning bij integratie

        Wij richten de API zo in dat implementatie eenvoudig is. Volledige support wordt momenteel niet standaard aangeboden.

        • Bij vragen kun je contact opnemen via support@kyp.nl

        • Er is geen formeel supporttraject beschikbaar

        SLA

        Een Service Level Agreement (SLA) is bespreekbaar op aanvraag.

        💬 Opmerking: Geef bij je aanvraag aan wat je verwacht qua uptime, beschikbaarheid en reactietijd, dan kijken we samen wat er mogelijk is.