Wat is de Finly API-documentatie?
Op www.finly.nl/developers staat de volledige API-documentatie van Finly. Met de Finly API kun je gegevens uit Finly ophalen en gebruiken in andere applicaties. Denk aan het ophalen van volledige klantdossiers, formulierinstanties, subaccounts en meer, zodat je jouw eigen applicatie kunt verrijken met actuele Finly-data.
Hoe is de documentatie opgebouwd?
De API-documentatie bestaat uit standaardvelden én eventuele eigen toegevoegde velden die per omgeving kunnen verschillen. De documentatie wordt daarom dynamisch opgebouwd op basis van de eigen inrichting. Dit betekent dat de documentatie die jij ziet, aansluit op jouw specifieke omgeving.
Per endpoint zie je:
Parameters: de velden die je meegeeft in het verzoek
Response: de velden die je terugkrijgt, inclusief type (string, integer, dateTime, array, etc.)
De documentatie is zo opgezet dat een developer in principe zonder aanvullende ondersteuning van Blinqx aan de slag kan.
Toegang tot de documentatie
De API-documentatie staat achter een inlog en is niet openbaar toegankelijk. Dit komt doordat de documentatie ook eigen (klantspecifieke) velden bevat.
Wil een developer toegang tot de documentatie? Dan zijn er twee opties:
Tijdelijk een inlogaccount aanmaken voor de developer
De documentatiepagina als PDF exporteren en aanleveren
API key: hoe werkt dat?
Om daadwerkelijk verzoeken te kunnen doen naar de API, is een API key nodig. Dit is een account-specifieke sleutel die eenmalig wordt aangemaakt.
Belangrijk:
De API key geeft toegang tot de volledige omgeving. Bewaar hem daarom goed en veilig, en deel hem niet met onbevoegden.
Het aanvragen van een API key gaat via een opdracht bij je consultant.
Moet een API key worden vervangen (bijvoorbeeld bij verlies of security-risico)? Dit is een opdracht. Let op: na vervanging moeten alle bestaande koppelingen die de oude key gebruiken ook worden bijgewerkt.
Ondersteuning nodig?
Een developer kan met de documentatie zelfstandig integreren. Lukt het toch niet zonder hulp, of wil je dat Blinqx meedenkt of meekijkt? Dan is het mogelijk om dit als opdracht neer te leggen. Neem contact op met je vaste contactpersoon bij Blinqx.