De Certyneo API voor elektronische ondertekening in Postman
Importeer de openbare Certyneo-collectie in Postman en test elk eindpunt van de REST API v1 — enveloppen aanmaken, verzenden, statusbewaking, webhooks — met al ingevulde voorbeeldverzoeken.
Gratis en openbare collectie. Een Certyneo API-sleutel is vereist om verzoeken uit te voeren.
Waarom de Certyneo Postman-collectie gebruiken
De collectie is ontworpen voor ontwikkelaars die de Certyneo API willen verkennen zonder eerst de volledige documentatie te lezen voordat ze hun eerste verzoek indienen.
Kant-en-klare verzoeken
Elk eindpunt van de REST API v1 is gedocumenteerd met een voorbeeldverzoek en -antwoord, klaar om uit te voeren nadat u uw API-sleutel hebt ingevoerd.
Testomgevingen
Een Postman-omgevingsvariabele bevat uw API-sleutel en basis-URL, om gemakkelijk tussen uw accounts of omgevingen te schakelen.
Automatisch gegenereerde documentatie
De Postman-documentatie van de verzameling blijft gesynchroniseerd met de OpenAPI-specificatie van de Certyneo API — geen verschil tussen wat u test en wat in productie is.
Testen zonder code te schrijven
Maak een envelop, verzend deze en volg de status ervan rechtstreeks vanuit de Postman-interface, zelfs voordat u de API in uw toepassing integreert.
Wat de verzameling omvat
Een overzicht van de groepen eindpunten die beschikbaar zijn in de openbare verzameling.
| Groep | Wat het bevat |
|---|---|
| Enveloppen | Een ondertekeningsenvelop maken, verzenden, weergeven, raadplegen en annuleren. |
| Documenten | Een document uploaden of importeren vanaf een URL (sourceUrl), en de status ervan raadplegen. |
| Ondertekenaars | Geadresseerden toevoegen, hun ondertekeningsvolgorde en niveau (SES/AES) bepalen. |
| Webhooks | Abonnementen op ondertekeningsgebeurtenissen maken en beheren. |
| Massaverzending | Meerdere enveloppen in één verzoek verzenden voor bulkhandtekeningcampagnes. |
De collectie is openbaar leesbaar: u kunt deze raadplegen zonder account, maar het uitvoeren van verzoeken vereist een geldige Certyneo API-sleutel.
Aan de slag met de collectie in 4 stappen
U hebt minder dan 5 minuten nodig om uw eerste verzoek in te dienen.
- 1
De openbare collectie importeren
Open vanuit Postman de openbare Certyneo-collectie en klik op « Fork » of « Import » om deze naar uw eigen ruimte te kopiëren.
- 2
Een Certyneo API-sleutel genereren
Open in uw Certyneo-dashboard Instellingen → API-sleutels en maak een sleutel aan die specifiek voor Postman is bestemd.
- 3
De omgevingsvariabele invullen
Plak uw API-sleutel in de omgevingsvariabele van de Postman-collectie, samen met de basis-URL van de API.
- 4
Een eerste verzoek verzenden
Voer het verzoek « Een enveloppe maken » uit en volg het resultaat rechtstreeks in Postman.
Beveiliging en best practices
De verzoeken uit de collectie gaan via dezelfde API als uw productietoepassing: dezelfde beveiligingsregels zijn van toepassing.
- Alle verzoeken worden verzonden via HTTPS/TLS 1.2 minimum.
- Elke API-sleutel is beperkt tot de rechten die u eraan hebt verleend bij aanmaak.
- Gebruik een toegewezen testsleutel voor uw Postman-tests, los van uw productie-sleutel.
- Een gecompromitteerde of ongebruikte API-sleutel kunt u met één klik intrekken vanuit uw Certyneo-dashboard.
Veelgestelde vragen
Is een betaald abonnement nodig om de Postman-collectie te gebruiken?
Nee. De collectie is openbaar en gratis. De limieten van uw Certyneo-abonnement (aantal enveloppen, functies) zijn van toepassing op uitgevoerde verzoeken, net als bij elk API-gebruik.
Waar vind ik mijn API-sleutel?
In uw Certyneo-dashboard, onder Instellingen → API-sleutels. Maak een sleutel aan die speciaal voor uw Postman-tests bedoeld is.
Is de collectie up-to-date met de nieuwste versie van de API?
Ja, de collectie wordt bij elke update van de REST API v1 opnieuw gegenereerd op basis van de officiële OpenAPI-specificatie van de Certyneo-API.
Kan ik webhooks testen via Postman?
Ja, de collectie bevat de eindpunten voor het aanmaken en vermelden van uw webhook-abonnementen. Om lokaal events te ontvangen, gebruikt u een HTTP-tunnelservice voor uw tests.
Kost het gebruik van de Postman-collectie iets?
Nee, alleen het API-verbruik zelf (het aanmaken van enveloppen) wordt in mindering gebracht op uw abonnement, net als een gewone API-aanroep.
Meer informatie
Test de Certyneo-API in Postman
Openbare, gratis collectie, gesynchroniseerd met onze ontwikkelaarsdocumentatie.