VertiCer API voor Handelaren (bèta)

Automatiseer uw handel via de VertiCer API

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.

Met de API kunt u:

✅ Alle geldige GVO's binnen uw account ophalen inclusief eigenschappen.

✅ Transacties uitvoeren:

  • Transfer: overdracht van GVO's binnen Nederland aan een andere handelaar.
  • Export: overdracht van GVO's naar een handelaar binnen een aangesloten AIB-register.
  • 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.

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.

Meer over ons

Heeft u vragen of opmerkingen over de API? 

Heeft u specifieke vragen of opmerkingen over het gebruik van de API? Neem dan contact op via [email protected]. VertiCer bekijkt deze mailbox iedere week.  // Maak hiervoor gebruik van onderstaand vragenformulier?? i.v.m aangegeven format in doc Aanmeldprocedure! //

Vragenformulier API

Waar wilt u meer over weten? 

Kies een van de onderstaande onderwerpen

Stap 1: Akkoord op algemene voorwaarden

Om toegang te krijgen tot de API-documentatie en de bètaomgeving vragen wij u eerst akkoord te gaan met de aanvullende API-voorwaarden van VertiCer.

Deze voorwaarden worden door onze servicedesk verstrekt.

📧 Akkoord sturen naar: [email protected]

Stap 2: Ontvang uw toegang

Na ontvangst van uw akkoord ontvangt u:

  • toegang tot de API-documentatie;
  • toegang tot de bètaomgeving;
  • een API-sleutel (API Key).

Uw ontwikkelaars kunnen hiermee starten met de integratie van de API in uw eigen software.

Stap 3: Ondersteuning tijdens het testen

Vragen over de API of testresultaten kunnen worden gestuurd naar:

📧 [email protected]

Gebruik hierbij het voorgeschreven supporttemplate uit de documentatie. Alleen verzoeken die volgens dit format worden aangeleverd kunnen worden behandeld.

VertiCer streeft naar een reactietermijn van maximaal 8 werkdagen.

Stap 4: Gereed voor productie

Wanneer de integratie succesvol is getest, kunt u dit melden via:

📧 [email protected]

De bètaomgeving bevat fictieve testdata en heeft geen invloed op uw daadwerkelijke GVO-voorraad of transacties in het handelsportaal.

Alle testtransacties zijn volledig gescheiden van de productieomgeving.

Stap 5: Productie-omgeving en API-sleutel
Voor gebruik in productie ontvangt iedere organisatie een eigen unieke API-sleutel.
Deze sleutel:
  • wordt opgehaald door een geautoriseerde gebruiker binnen het handelsportaal;
  • geeft toegang om namens uw organisatie transacties uit te voeren;
  • moet strikt vertrouwelijk worden behandeld.
Via het handelsportaal kan uw organisatie:
  • de API-voorwaarden accepteren;
  • een API-sleutel genereren;
  • een sleutel roteren (vernieuwen);
  • API-gebruik uitschakelen;
  • bij een vermoeden van misbruik direct een nieuwe sleutel aanmaken.
Belangrijk: iedereen met toegang tot uw API-sleutel kan namens uw organisatie handelen. Het veilig beheren van deze sleutel is de verantwoordelijkheid van uw organisatie.
Om veiligheidsredenen kunnen medewerkers van VertiCer API-sleutels niet inzien.
Stap 6: 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:

  1. wordt deze eerst beschikbaar gesteld in de bètaomgeving;
  2. informeren wij u tijdig over de wijzigingen;
  3. 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.

Stap 7: Houd rekening met doorlopende kosten

Het gebruik van API-integraties vraagt niet alleen een initiële investering, maar ook toekomstig onderhoud.

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.

Algemene Voorwaarden API

Documentatie voor gebruik API