Arendajatele · REST API

Digiallkirja API sinu süsteemile

Lae dokument üles, kutsu allkirjastajad ja too allkirjastatud fail oma süsteemi tagasi. Allkirjastaja kasutab Smart-ID-d, Mobiil-ID-d, ID-kaarti või teise EL-i riigi eID-d — allkirjastamist ei pea ise ehitama.

Loo konto ja API-võti Vaata hinda API dokumentatsioon

Õiguslikult võrdne omakäelise allkirjaga igas EL-i riigis (eIDAS QES).

Kvalifitseeritud digiallkiri sinu süsteemis, ilma oma eID-liidestuseta.

Dokumendid

Lae PDF või ASiC-E konteiner üles multipart-päringuga — base64-välja ega väikest mahupiiri pole. Küsi olekut ja lae alla allkirjastatud fail või algne dokument.

Allkirjastajad

Lisa allkirjastaja e-posti aadressiga — ta saab lingi — või isikukoodi ja riigiga, siis jõuab kutse tema 1DOX-i postkasti ilma kirjata. Kui saadad kutsed ise, tagastab API allkirjastamise lingi.

Saada meeldetuletus, eemalda allkirjastaja või tühista kõik ootel kutsed.

Veebikonksud

1DOX teatab sinu aadressile, kui allkiri lisandub, dokument valmib või allkirjastaja keeldub. Teade on allkirjastatud HMAC-SHA256-ga ja ebaõnnestunud saatmist korratakse kuni 5 korda. Olekut pole vaja pärida.

Kvalifitseeritud allkiri

Allkirjastaja allkirjastab 1DOX-i lehel oma eID-ga. Tulemus on kvalifitseeritud elektrooniline allkiri (QES) eIDAS määruse mõistes, kehtiv kogu Euroopa Liidus.

Võtmed tööruumi kaupa

API-võti kuulub ühele tööruumile ja näeb ainult selle dokumente. Igal tööruumil võib olla kuni kolm võtit — anna igale liidestusele oma.

OpenAPI dokumentatsioon

Kõik päringud ja veebikonksu sisu on kirjeldatud OpenAPI 3.1 spetsifikatsioonis. Vead tulevad RFC 9457 vormingus.

Kuidas alustada

1. samm

Loo konto

Loo 1DOX-i konto ja vali isiklik või ettevõtte tööruum.

2. samm

Loo API-võti

Seadete jaotises API loo võti ja lisa veebikonksu aadress.

3. samm

Saada dokument

Lae dokument üles, lisa allkirjastajad ja oota veebikonksu teadet, et dokument on valmis.

Hind

API eest eraldi ei maksa: API-võtme saad igas paketis, ka tasuta. Allkiri maksab sama palju kui portaalis — tavaline digiallkiri 0,36 €, rahvusvaheline kaug-QES 6 € — ja selle maksab dokumendi omanik. Iga uus konto saab alustuseks 5 € tasuta allkirjakrediiti.

Allkirja hind · maksad kasutuse järgi

0,36 €/ tavaallkiri

Smart-ID, Mobiil-ID, ID-kaart

Premium QES: 6 €nt ADACOM-i kaug-QES välismaistele allkirjastajatele, kel pole kohalikku eID-d

Võta 5 € tasuta krediiti

Korduma kippuvad küsimused

Kas pean Smart-ID või ID-kaardi liidestuse ise tegema?

Ei. Allkirjastamine käib 1DOX-i allkirjastamise lehel, kus on Smart-ID, Mobiil-ID, ID-kaart ja teiste EL-i riikide eID-d. Sinu süsteem saadab dokumendi ja saab tagasi allkirjastatud faili.

Kas allkirjastaja vajab 1DOX-i kontot?

E-posti kutsega mitte: ta avab lingi ja allkirjastab. Isikukoodiga seotud kutse jõuab tema 1DOX-i postkasti, kuhu ta logib sisse oma eID-ga.

Kuidas veebikonksu teadet kontrollida?

Arvuta päringu toorest kehast HMAC-SHA256 tööruumi veebikonksu saladusega ja võrdle päisega x-1dox-signature. Kordused kannavad sama deliveryId-d, nii saad juba töödeldud teate vahele jätta.

Kas paketi piirangud kehtivad ka API-le?

Jah. API kaudu üles laetud dokument läbib samad kontrollid kui portaalis: dokumentide arv ja faili suurus käivad tööruumi paketi järgi.

Kus on API dokumentatsioon?

Aadressil 1dox.eu/docs/api. Masinloetav OpenAPI spetsifikatsioon on aadressil 1dox.eu/api/v1/openapi.json.

Valmis allkirjade taga ajamisest loobuma?

Liitu enam kui 8000 kasutajaga, kes allkirjastavad üle Euroopa kiiremini ja nutikamalt.

Loo konto ja API-võtiPangakaarti pole vaja. Igakuist kohustust pole.

eIDAS kvalifitseeritud allkirjadIsikuandmete kaitse nõuetega kooskõlasDokumente hoitakse EL-is