Chaindoc REST API viide

Täielik viide Chaindoc REST API integreerimiseks teie rakendustesse. Halda dokumente, allkirju, plokiahela kontrolli ja sisseehitatud allkirjastamise töövooge.

Ülevaade

Chaindoc REST API pakub programmilist juurdepääsu dokumentide haldamisele, plokiahela kontrollimisele ja digitaalallkirja funktsionaalsusele. API on mõeldud serveritevaheliseks integreerimiseks ja toetab nii avalikku kui ka salajast API võtit.

Peamised omadused

• Dokumentide haldamine – looge, uuendage ja haldage dokumente plokiahela kontrolliga
• Digitaalsed allkirjad – taotlege ja koguge digitaalseid allkirju mitmelt osapoolelt
• Blockchaini kontroll – kontrollige dokumendi autentsust blockchaini võrgustikes
• Sisseehitatud sessioonid – looge turvalised sessioonid esmase allkirjastamise töövoogude jaoks
• Meedia üleslaadimine – Laadige üles failid (PDF, pildid, videod) dokumendi loomiseks
• KYC-integratsioon – jagage ja kontrollige isikuandmeid Sumsubiga

Autentimine

Chaindoc API kasutab autentimiseks API võtmeid. On olemas kahte tüüpi võtmed, millel on erinevad juurdepääsutasemed.

API võtmetüübid

• Avalik võti (pk_) – ainult lugemisõigus frontend-rakendustele ja kontrollimiseks
• Salajane võti (sk_) – täielik lugemis- ja kirjutusõigus tagapõhja serveritele

API-võtmete hankimine

API-võtmete kasutamine

Lisage oma API-võti autoriseerimise päises koos kandja autentimisega:

curl -X GET https://api.chaindoc.io/api/v1/me \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

Kiiruse piiramine

API-sihtpunktide kasutamine on piiratud, et vältida kuritarvitamist. Kasutamise piirangud varieeruvad sihtpunkti tüübi järgi.

• Üldised piirangud: 3 päringut 10 sekundi jooksul
• Meedia üleslaadimine: 3 taotlust 10 sekundi jooksul
• OTP-kinnitus: 5 taotlust 60 sekundi jooksul
• Lugemisoperatsioonid: 10 päringut 60 sekundi jooksul
• Allkirja loomine: 20 taotlust 3 sekundi jooksul

Kui kiiruspiirang ületatakse, saate vastuseks 429 Too Many Requests (Liiga palju päringuid). Kiiruspiirangu päised on vastustes olemas:

X-RateLimit-Limit: 3
X-RateLimit-Remaining: 2
X-RateLimit-Reset: 1640000000

Veakäsitlus

HTTP-staatuskoodid

• 200 – Edukas
• 201 – Ressurss loodi edukalt
• 400 – Vale päring (valideerimisviga)
• 401 – Lubamatu (kehtetu või puuduv API-võti)
• 403 – Keelatud (ebapiisavad õigused)
• 404 – Ressurssi ei leitud
• 429 – Liiga palju päringuid (kiiruspiirang ületatud)
• 500 – Sisemine serveriviga

Veateate vorming

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request",
  "details": [
    {
      "field": "name",
      "message": "name must be a string"
    }
  ]
}

Üldine API

Hangi API võtme info

Hangi teavet praeguse API-võtme kohta.

GET /me

Authorization: Bearer sk_live_xxxxx

Tervisekontroll

Kontrollige API ühenduvust ja võtme kehtivust.

GET /health

Authorization: Bearer sk_live_xxxxx

Dokumendid API

Dokumendi loomine

Looge uus dokument koos plokiahela kontrolliga. Kui staatus on seatud „avaldatud”, kontrollitakse dokumenti automaatselt plokiahelas.

POST /documents

Headers:
Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

Dokumendi uuendamine

Dokumenti uuendage, luues uue versiooni. Eelmised versioonid säilitatakse auditeerimiseks.

PUT /documents/:documentId

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

Dokumendi juurdepääsuõiguste uuendamine

Uuendage dokumendi juurdepääsu kontrolli seadeid.

PUT /documents/:documentId/rights

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

Dokumendi kontrollimine

Kontrollige dokumendi autentsust blockchaini abil. Tagastab kontrolli staatuse koos tehingu hash-koodi ja ahela ID-ga.

POST /documents/verify

{
  "versionHash": "0x123abc...",
  "certificateHash": "0x456def..."
}

Saada kinnituse staatus

Hangi dokumendi versiooni jaoks plokiahela kinnituse staatus.

GET /documents/versions/:versionId/verification

Authorization: Bearer sk_live_xxxxx

Allkirjade API

Loo allkirja taotlus

Looge allkirja taotlus ühele või mitmele adressaadile. Lubage sisseehitatud voog frontend-integratsiooni jaoks.

curl -X POST https://api.chaindoc.io/api/v1/signatures/requests \
  -H "Authorization: Bearer sk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "versionId": "f0b7721f-0399-4035-9b69-7b95d3a367f0",
    "recipients": [{"email": "signer@example.com"}],
    "deadline": "2024-12-31T23:59:59Z",
    "embeddedFlow": true
  }'

Hangi allkirja taotluse staatus

Kontrollige allkirja taotluse staatust ja vaadake, millised allkirjastajad on allkirjastamise lõpetanud.

GET /signatures/requests/:requestId/status

Authorization: Bearer sk_live_xxxxx

Dokumendi allkirjastamine

Allkirjastage dokument (kui API võtme omanik on allkirjastaja).

POST /signatures/sign

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

Hangi kasutajate allkirjad

Hangi kõik autentimitud kasutaja allkirjad.

GET /signatures

Authorization: Bearer sk_live_xxxxx

Hangi allkirja taotlused

Hangi kõik autentimitud kasutaja allkirjataotlused lehekülgede nummerdamise toega.

GET /signatures/requests?pageNumber=1&pageSize=10

Authorization: Bearer sk_live_xxxxx

Meedia üleslaadimise API

Laadige üles failid, mida soovite dokumendi loomisel kasutada. Toetab PDF-faile, pilte ja videoid. Maksimaalselt 10 faili ühe taotluse kohta.

curl -X POST https://api.chaindoc.io/api/v1/media/upload \
  -H "Authorization: Bearer sk_live_xxxxx" \
  -F "media=@contract.pdf"

KYC API

Jagage KYC-andmeid

Jagage KYC (Know Your Customer) andmeid vastuvõtjatega identiteedi kontrollimiseks.

POST /kyc/share

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

Sisseehitatud sessioonide API

Looge oma esitusrakenduses dokumendi allkirjastamiseks sisseehitatud sessioonid. Sessioonid kehtivad 10 minutit.

POST /embedded/sessions

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json