Conscribo connector (XML / JSON API)

Conscribo geeft u als klant de mogelijkheid om een API (application programming interface) te ontwikkelen. Op deze manier kunt u via uw eigen website een connectie maken met uw Conscribo en gegevens in uw administratie wijzigen. Denk hierbij bijvoorbeeld aan het toevoegen en wijzigen van transacties en relaties. Met zo’n API kunnen leden van een vereniging bijvoorbeeld hun eigen gegevens bijhouden.

Let op: De Conscribo API vereist dat u een stuk software in uw eigen website ontwikkelt of aanpast en kan dus niet kant en klaar in uw website worden geplaatst.

Het gebruik van de API is gratis voor elke Conscribo klant.

Om met de Conscribo API te kunnen ontwikkelen, dient u de volgende stappen te nemen:

1. Maak op de pagina De Conscribo Producten een nieuw demoaccount aan ten behoeve van tests, met als product dezelfde als uw eigen administratie.
2. Zorg, waar van toepassing, voordat u gaat ontwikkelen, dat de gegevens in uw demoaccount overeenkomen met uw eigen administratie. Dat doet u aan de hand van het importeren en exporteren van uw administratie naar het demoaccount.
3. Maak een gebruiker in deze administratie aan voor de API. Deze gebruiker gebruikt u in de API om mee te authenticeren.
4. Begin met ontwikkelen in uw demoaccount.
5. Indien u gereed bent, past u de accountnaam in de API aan naar de definitieve account.

Documentatie en voorbeelden:

De specificatie van de Koppeling (Zowel de XML als JSON variant)

API Documentatie 2021-08-12

Voor PHP hebben we een library gemaakt voor snelle integratie. Deze maakt gebruik van de JSON API variant, en wordt bij het ontwikkelen voor PHP aanbevolen te gebruiken:

Conscribo PHP JSON connector In het ZIP-bestand API bestanden zit een voorbeeld (connectCustomerExample.php) over hoe uw API er uit kan zien.

Meer informatie over de instellingen van de Conscribo API in de administratie, zie onze handleiding: De Conscribo XML API