Technische documentatie: alle actuele API-routes, rechten en voorbeelden staan op docs.fitsociety.io. Begin als ontwikkelaar bij de Public API-snelstart.
Werk je samen met een externe ontwikkelaar? Spreek vooraf af welk systeem je koppelt, welke gegevens nodig zijn, welke acties de koppeling mag uitvoeren en wie de koppeling beheert. Laat de beheerder de client in het juiste bedrijf aanmaken. Geef je ontwikkelaar de documentatielink en alleen de benodigde verbindingsgegevens via een beveiligd kanaal; deel je coachwachtwoord niet. Gebruik een aparte client per koppeling, zodat je de toegang later gericht kunt intrekken.
Een API-client is de toegang voor één externe koppeling binnen jouw bedrijf. Een bevoegde beheerder maakt deze aan. Je ontwikkelaar gebruikt het client-ID en client secret om de verbinding technisch in te stellen.
In dit artikel
1. Maak een API-client aan
Selecteer het juiste bedrijf in het coachdashboard.
Ga naar Instellingen → Plug-ins en integraties → Public API.
Open OAuth-clients en kies API-client toevoegen.
Geef een herkenbare naam, bijvoorbeeld “CRM-koppeling”, en controleer de geselecteerde scopes.
Accepteer alleen de vereiste gegevenstoestemmingen voor deze koppeling en kies Client aanmaken.
Kopieer het client-ID en het eenmalig getoonde client secret. Bewaar ze veilig en draag ze beveiligd over aan je ontwikkelaar.
Gebruik een aparte client per koppeling. Deel geen coachwachtwoord en zet secrets niet in een helpdeskbericht of openbare code.
2. Kies alleen de benodigde rechten
Scopes bepalen wat de koppeling mag. clients:read laat bijvoorbeeld cliëntgegevens lezen; clients:write geeft toegang tot ondersteunde schrijfacties. Controleer de voorselectie: alleen lezen staat niet vanzelf voor iedere nieuwe koppeling aan.
Gezondheidsgegevens en privécommunicatie vragen aanvullende, expliciete toestemming. Voor bedrijfsbrede statusautomatisering bestaan aparte rechten: client_status_automation:read en client_status_automation:write. Alleen cliënten mogen wijzigen geeft die laatste toestemming niet.
De rechten van bestaande API-clients worden niet automatisch uitgebreid. Wil je andere scopes gebruiken? Maak in dit scherm een nieuwe client met de gewenste rechten, laat de ontwikkelaar overstappen en trek daarna de oude client in.
3. Laat de verbinding controleren
De ontwikkelaar wisselt de gegevens via OAuth om voor een tijdelijk toegangstoken. Dat token is één uur geldig. Begin met een leesaanroep, bijvoorbeeld het profiel van de API-client, volgens de technische snelstart.
Er is geen aparte sandbox voor de publieke API. Schrijfacties werken op echte bedrijfsgegevens. Controleer samen eerst één afgesproken workflow voordat je meer acties automatiseert.
4. Vernieuwen, intrekken of een fout oplossen
Secret vernieuwen: gebruik dit als het secret kwijt of uitgelekt is. De oude gegevens en actieve toegangstokens worden ongeldig; werk de koppeling direct bij.
Intrekken: stopt deze API-client en maakt de actieve tokens ongeldig. Dit kun je niet ongedaan maken; voor een nieuwe verbinding maak je een nieuwe client.
401: laat het token en de aanmeldgegevens controleren.
403: controleer scopes, gegevenstoestemming en de toegang van het bedrijf.
429: de koppeling verstuurt te veel aanvragen; de ontwikkelaar moet de wachttijd respecteren.
Hulp nodig? Deel de foutcode, het tijdstip en eventueel het request-ID met support, zonder secrets of toegangstokens.
Verder lezen
Technische documentatie voor je ontwikkelaar (Engels)