API-documentatie

De Raisetalk-API in OpenAPI-formaat: documentatie die uit de code wordt gegenereerd, en een client-SDK genereren in de programmeertaal van uw keuze.

De volledige documentatie is beschikbaar in de Raisetalk-app. De documentatie openen in de app

OpenAPI-documentatie

De volledige documentatie van de Raisetalk-API is in OpenAPI-formaat beschikbaar op het volgende adres: https://api.raisetalk.com/docs.

Deze documentatie wordt automatisch gegenereerd uit de broncode van de API en bij elke deployment bijgewerkt, waardoor ze altijd getrouw het werkelijke gedrag van de aangeboden endpoints weergeeft.

Het ruwe specificatiebestand is ook beschikbaar op https://api.raisetalk.com/openapi.yaml.

Een SDK genereren

Op basis van deze OpenAPI-specificatie kunt u met de tool openapi-generator-cli eenvoudig een client-SDK genereren in vrijwel elke programmeertaal (PHP, Python, TypeScript, Java, Go, Ruby, C#, enz.).

Voorbeeld voor het genereren van een PHP-SDK:

docker run --rm \
  -v "${PWD}:/local" \
  openapitools/openapi-generator-cli generate \
  -i https://api.raisetalk.com/openapi.yaml \
  -g php \
  -o /local/sdk/php

Wilt u een andere doeltaal, dan vervangt u gewoon de waarde van de parameter -g (bijvoorbeeld -g python, -g typescript-axios, -g java, enz.).

De volledige lijst van beschikbare generators en de uitgebreide documentatie van de tool vindt u op de officiële website: https://openapi-generator.tech/.