Boek een demo DataCollect Documentatie 1.0
Wijzigingsgeschiedenis – Klik hier
Over dit document
Dit document geeft een volledig overzicht van de DataCollect API en hoe data geïntegreerd kan worden in Verarca.
Het document biedt richtlijnen voor het starten met het inladen van data en hoe dit proces gevolgd moet worden.
Het is van groot belang dat je het hele document leest en eventuele vragen vooraf verstuurt naar rene@verarca.com voordat je met de integratie start.
Contactinformatie
Neem contact op met de volgende adressen als je vragen hebt:
Technische support: rene@verarca.com
Overige vragen: contact@verarca.com
Inleiding
De eerste integratie met onze API gebeurt via een account op Verarca.com. Voor toegang tot een testaccount kun je contact opnemen via rene@verarca.com.
De DataCollect API bestaat uit twee omgevingen: staging en productie, bereikbaar via de volgende endpoints:
Staging: https://staging.datacollect.verarca.com/swagger
Productie: https://datacollect.verarca.com/swagger
Beide omgevingen draaien verschillende beveiligingscontroles om stabiliteit te waarborgen. Eén daarvan is rate limiting. Bij problemen kun je contact opnemen met de technische support.
De API maakt gebruik van versiebeheer. Het wordt sterk aangeraden de versies van de endpoints te gebruiken om verstoringen te minimaliseren. De versie is zichtbaar in de Swagger-documentatie.
De volgende hoofdstukken beschrijven de workflow voor het inladen van data in DataCollect in specifieke dataregio’s.
Boekhouding
De basisdata van Verarca bestaat uit data uit ERP-/boekhoudsystemen voor het berekenen van CO2 op basis van diverse aankopen/facturen.
De volgende workflow moet altijd worden gevolgd:
1. Klant ontvangt een token van Verarca.com.
2. Klant voert dit token in of geeft het door aan de clientapplicatie (integratiepartner).
3. Bij invoer van het token in de clientapplicatie moet de applicatie een totaaloverzicht van het rekeningschema doorgeven.
4. Nadat het rekeningschema is doorgestuurd naar DataCollect, moet de klant in Verarca.com de relevante accounts aanvinken.
– Dit is om alleen data met betrekking tot CO2 te verwerken.
5. Dagelijks moet de clientapplicatie de volgende gegevens indienen bij DataCollect:
-
- Ophalen welke accounts in Verarca.com zijn aangevinkt. Endpoint: /api/Accounts/Enabled
- Aanmaken/bijwerken van rekeningschema: /api/Accounts
- Aanmaken/bijwerken van boekingen: /api/AccountEntries
- Koppelen/uploaden van documenten aan boekingen: /api/Documents
Bij de eerste synchronisatie moet altijd data van het huidige jaar + voorgaand jaar worden aangeleverd. Dagelijks moeten alle updates/nieuwe data worden ingediend.
Bij het indienen van boekingen moet het type van de boeking worden opgegeven via de parameter “type”. DataCollect ondersteunt de volgende formaten:
Supplier = Factuur van een leverancier
Payment = Betaling aan een leverancier
Credit = Creditnota van een leverancier
Foutafhandeling
Als er problemen optreden met de DataCollect API, retourneert de API een JSON-resultaat zoals hieronder:
Neem bij vragen contact op met de technische support en vermeld daarbij de errorId voor een snellere afhandeling.
Wijzigingsgeschiedenis
| Datum | Wijzigingen | Type |
