VertiCer API voor Handelaren (bèta)
Met de VertiCer API kunt u de belangrijkste handelsactiviteiten rechtstreeks vanuit uw eigen software uitvoeren. Daarmee vermindert u handmatig werk en kunt u processen efficiënter automatiseren.
Op deze pagina vindt u de belangrijkste informatie en bijbehorend stappenplan om gebruik te kunnen maken van onze API.
Wat kunt u met de API?
- Alle geldige GVO's binnen uw account ophalen inclusief eigenschappen.
- Transacties uitvoeren:
a) Transfer: overdracht van GVO's binnen Nederland aan een andere handelaar.
b) Export: overdracht van GVO's naar een handelaar binnen een aangesloten AIB-register.
c) Redeem: afboeking van GVO's voor:
* een energieleverancier;
* een eindgebruiker;
* omzetting naar waterstof-GVO's via een electrolyzer. - De status van transacties ophalen om:
- te controleren of transacties succesvol zijn verwerkt;
- transacties te koppelen aan VertiCer-facturen.
Wat is niet beschikbaar via de API?
De volgende functionaliteiten zijn momenteel uitsluitend beschikbaar binnen het handelsportaal:
- Terugtrekverzoeken verwerken.
- Collections aanmaken, wijzigen of verwijderen.
- GVO's toekennen aan collections.
Hiermee behoudt u maximale vrijheid om uw eigen portefeuillebeheer binnen uw softwareomgeving vorm te geven.
Om toegang te krijgen tot de API-documentatie en de bètaomgeving vragen wij u eerst akkoord te gaan met de aanvullende algemene voorwaarden (API-voorwaarden) van VertiCer.
Deze voorwaarden vindt u onderaan deze pagina.
📧 Uw akkoord, inclusief API-voorwaarden in de bijlage, sturen naar: [email protected].
Na ontvangst van uw akkoord ontvangt u een API-sleutel (API key) voor toegang tot de toegang tot de bètaomgeving.
Op deze pagina vindt u aanvullende API-documentatie waarmee uw ontwikkelaars kunnen starten met de integratie van de API in uw eigen software.
Vragen over de API of testresultaten kunnen worden gestuurd naar:
Gebruik hierbij het voorgeschreven support template uit het vragenformulier. Alleen verzoeken die volgens dit format worden aangeleverd kunnen worden behandeld.
VertiCer streeft naar een reactietermijn van maximaal 8 werkdagen.
Wanneer de integratie succesvol is getest, kunt u dit melden via:
De bètaomgeving bevat fictieve testdata en heeft geen invloed op uw daadwerkelijke GVO-voorraad of transacties in het handelsportaal.
Alle handelaren testen op deze omgeving en VertiCer zal de data van deze omgeving geregeld verversen zodat u consistentie in het testen houdt.
De testtransacties zijn volledig gescheiden van de productieomgeving.
API-gebruik in productie
De API is momenteel uitsluitend beschikbaar in de bètaomgeving.
Wanneer de API in de productie-omgeving beschikbaar komt, informeert VertiCer u hierover via een nieuwsbrief. Op dat moment zijn nog enkele aanvullende stappen nodig.
Uw integratie aanpassen voor productie
Voor gebruik in de productie-omgeving veranderen twee zaken:
- U gebruikt een unieke API-sleutel voor uw organisatie.
- De locatie (endpoint) van de API wijzigt.
Voor de nieuwe API-locatie publiceert VertiCer een bijgewerkt YAML-bestand.
Unieke API-sleutel voor uw organisatie
Een geautoriseerde gebruiker van uw organisatie kan deze API-sleutel ophalen via het handelsportaal.
LET OP: De API-sleutel wordt slechts één keer volledig getoond. Bewaar deze daarom direct op een veilige locatie. Ook VertiCer heeft geen toegang tot deze sleutel en kan deze niet opnieuw verstrekken.
De gebruiker kan daarnaast:
- de API activeren of beëindigen;
- een automatische rotatieperiode instellen;
- tussentijds zelf een nieuwe API-sleutel aanvragen (rotatie).
Veilig beheer van uw API-sleutel
Uw API-sleutel geeft volledige toegang om namens uw organisatie transacties uit te voeren.
Belangrijk: het is daarom uw verantwoordelijkheid om ervoor te zorgen dat:
- de sleutel vertrouwelijk blijft;
- uitsluitend geautoriseerde systemen toegang hebben tot de sleutel;
- de sleutel veilig wordt opgeslagen.
Bij een vermoeden van misbruik of uitlekken kan de sleutel direct worden geroteerd via het handelsportaal.
Omdat de vertrouwelijkheid van API-sleutels essentieel is, kunnen medewerkers van VertiCer deze sleutels niet inzien. Alleen een gebruiker binnen uw organisatie kan de sleutel eenmalig bekijken.
Met de nieuwe API-locatie en uw unieke API-sleutel kunnen uw ontwikkelaars de reeds geteste integratie omzetten naar productie en koppelen aan het handelsportaal van VertiCer.
Documenten
Technische documentatie API (YAML file)
Onderhoud en toekomstige wijzigingen
De VertiCer API wordt doorlopend doorontwikkeld. Nieuwe wetgeving, aanpassingen binnen de AIB-standaard of wijzigingen in het handelsportaal kunnen aanleiding zijn om API-versies aan te passen.
Wanneer een nieuwe versie beschikbaar komt:
- wordt deze eerst beschikbaar gesteld in de bètaomgeving;
- informeren wij u tijdig over de wijzigingen;
- communiceren wij wanneer deze versie beschikbaar komt in productie.
Momenteel geldt dat oudere API-versies na introductie van een nieuwe versie mogelijk niet langer worden ondersteund.
Uiteraard blijft het handelsportaal beschikbaar als alternatief voor gebruikers die via het scherm blijven werken.
Houd rekening met doorlopende kosten
Het gebruik van de API is niet alleen een eenmalige investering. Houdt u hierbij ook rekening met toekomstige wijzigingen en uitbreidingen; deze kunnen kosten met zich meebrengen om optimaal gebruik te kunnen blijven maken van alle functionaliteiten.
Denk hierbij aan:
- wijzigingen in de VertiCer API;
- wijzigingen vanuit AIB-standaarden;
- onderhoud van uw eigen software;
- eventuele aanpassingen aan bestaande integraties.
Zo blijft uw koppeling veilig, stabiel en compatibel met toekomstige ontwikkelingen.
Heeft u vragen of opmerkingen over de API?
Neem dan contact op via [email protected]. VertiCer bekijkt deze mailbox iedere week.
Maak bij voorkeur gebruik van onderstaand vragenformulier, zodat wij uw vraag beter kunnen beoordelen.
Vragenformulier bèta API VertiCer
Heeft u vragen over de aanmeldprocedure voor de API?
Neem dan contact op met onze Servicedesk.
