Certyneo-sähköisen allekirjoituksen API Postmanissa
Tuo julkinen Certyneo-kokoelma Postmaniin ja testaa jokaista REST v1 -API:n päätepistettä — kirjekuoren luominen, lähettäminen, statuksen seuranta, webhookit — valmiiksi täytettyjen pyynnön esimerkkien avulla.
Ilmainen ja julkinen kokoelma. Pyyntöjen suorittamiseen tarvitaan Certyneo API -avain.
Miksi käyttää Certyneo Postman -kokoelmaa
Kokoelma on suunniteltu kehittäjille, jotka haluavat tutkia Certyneo API:ta ilman koko dokumentaation lukemista ennen ensimmäisen pyynnön lähettämistä.
Valmiit pyynnöt
Jokainen REST API v1:n päätepisteistä on dokumentoitu pyynnön ja vastauksen esimerkillä, joka on valmis suoritettavaksi API-avaimen syöttämisen jälkeen.
Testausympäristöt
Postman-ympäristömuuttuja sisältää API-avaimesi ja perus-URL:n, jotta voit helposti vaihtaa tileille tai ympäristöille.
Automaattisesti luotu dokumentaatio
Postman-dokumentaatio kokoelmasta pysyy synkronoituna Certyneo-ohjelmointirajapinnan OpenAPI-spesifikaation kanssa — ei viivettä sen välillä, mitä testaat ja mitä on tuotannossa.
Testaa ilman koodin kirjoittamista
Luo kirjekuori, lähetä se ja seuraa sen tilaa suoraan Postman-käyttöliittymästä, ennen kuin edes integroit ohjelmointirajapinnan sovellukseesi.
Mitä kokoelma kattaa
Yleiskatsaus käytettävissä olevista päätepisteen ryhmistä julkisessa kokoelmassa.
| Ryhmä | Mitä se sisältää |
|---|---|
| Kirjekuoret | Allekirjoituskirjekuoren luominen, lähettäminen, luettelointi, tarkastelu ja peruuttaminen. |
| Asiakirjat | Lataa asiakirja tai tuo se URL-osoitteesta (sourceUrl), tarkasta sen tila. |
| Allekirjoittajat | Lisää vastaanottajia, määritä heidän allekirjoitusjärjestyksensä ja tasonsä (SES/AES). |
| Webhookit | Luo ja hallitse tilauksia allekirjoitustapahtumille. |
| Joukkolähetys | Lähetä useita kirjekuoria yhdessä pyynnössä massaallekirjoituskampanjoille. |
Kokoelma on julkinen luettavaksi: voit tutustua siihen ilman tiliä, mutta pyyntöjen suorittaminen vaatii kelvollisen Certyneo API -avaimen.
Aloita kokoelma 4 vaiheessa
Alle 5 minuuttia ensimmäisen pyyntösi käynnistämiseen.
- 1
Tuo julkinen kokoelma
Avaa Postmanissa Certyneo-julkinen kokoelma ja napsauta « Fork » tai « Import » kopioida se omaan tilaan.
- 2
Luo Certyneo API -avain
Avaa Certyneo-hallintapaneelista Asetukset → API-avaimet ja luo Postmanille tarkoitettu avain.
- 3
Täytä ympäristömuuttuja
Liitä API-avaimesi Postman-kokoelman ympäristömuuttujaan sekä API:n perus-URL.
- 4
Lähetä ensimmäinen pyyntö
Käynnistä pyyntö « Luo kirjekuori » ja seuraa tulosta suoraan Postmanissa.
Turvallisuus ja parhaat käytännöt
Kokoelman pyynnöt käyttävät samaa API:a kuin tuotantosovelluksesi: samat suojauskäytännöt koskevat.
- Kaikki pyynnöt lähetetään vähintään HTTPS/TLS 1.2:lla.
- Jokaiselle API-avaimelle on rajoitettu luomishetkellä myönnetyt käyttöoikeudet.
- Käytä erityistä testausavainta Postman-testeihisi, erillään tuotantoavaimestasi.
- Vaarassa oleva tai käyttämätön API-avain voidaan peruuttaa yhdellä napsautuksella Certyneo-hallintapaneelissa.
Usein kysyttyjä kysymyksiä
Vaaditaanko maksettu palvelu Postman-kokoelmaa käyttääkseen?
Ei. Kokoelma on julkinen ja ilmainen. Certyneo-suunnitelmasi rajat (kirjekuorten määrä, toiminnot) koskevat suoritettuja pyyntöjä, kuten kaikissa API-käytöissä.
Mistä löydän API-avaimeni?
Certyneo-hallintapaneelissasi kohdassa Asetukset → API-avaimet. Luo avain, joka on omistautunut Postman-testeillesi.
Onko kokoelma ajan tasalla API:n uusimman version kanssa?
Kyllä, kokoelma luodaan uudelleen Certyneo-API:n virallisesta OpenAPI-spesifikaatiosta joka kerta kun REST-API v1:tä päivitetään.
Voinko testata webhookeja Postman-ohjelmalla?
Kyllä, kokoelma sisältää päätepisteen webhook-tilauksiesi luomiseen ja luetteloimiseen. Tapahtumien vastaanottamiseksi paikallisesti käytä HTTP-tunnelipalvelua testien ajaksi.
Onko Postman-kokoelmaa käyttäminen maksullista?
Ei, vain API:n itsensä kulutus (kirjekuorten luominen) vähennetään suunnitelmastasi, aivan kuten tavallinen API-kutsu.
Lue lisää
Testaa Certyneo-API:a Postman-ohjelmalla
Julkinen kokoelma, ilmainen, synkronoitu kehittäjädokumentaatiomme kanssa.