მოაწერე
დაიწყე უფასოდ
დეველოპერებისთვის

დააკავშირე შენი სისტემა მოაწერესთან

საჯარო REST API: ატვირთე დოკუმენტი, გაგზავნე ხელმოსაწერად, მიიღე ხელმოწერილი webhook-ები და ჩამოტვირთე საბოლოო ფაილები — შენი აპლიკაციიდან.

მიმოხილვა

  • რას აკეთებს API

    დოკუმენტების ატვირთვა, კონვერტის შექმნა მონაწილეებით, ველებით და ვადით, გაგზავნა, სტატუსის მიღება, გამოთხოვა და ხელმოწერილი PDF-ისა და მტკიცებულებების ჩამოტვირთვა.

  • ვის შეუძლია გამოყენება

    API წარმოებაში ხელმისაწვდომია კორპორაციულ პაკეტში. ინტეგრაციის შესაფასებლად sandbox უფასოა — sandbox-ის დოკუმენტები ლიმიტში არ ითვლება და შეტყობინებები რეალურ ადრესატებს არ ეგზავნება.

  • როგორ დავიწყო

    აპლიკაციაში გახსენი მენიუ „დეველოპერებისთვის“, შექმენი sandbox ინტეგრაცია, აირჩიე scope-ები და მიიღე client ID და საიდუმლო. საიდუმლო ერთხელ ჩანს.

API დოკუმენტაცია OpenAPI (openapi.json) ინტეგრაციის შექმნა აპლიკაციაში

დოკუმენტაცია ავტორიზაციის გარეშე იხსნება; მონაცემებზე ოპერაციები მოითხოვს ტოკენს, სწორ scope-ს და ორგანიზაციის უფლებას.

პირველი დოკუმენტის გაგზავნა

მოკლე გეგმა; ველების სრული აღწერა და პასუხების სქემები — API დოკუმენტაციაში. მაგალითები იყენებს გარემოს ცვლადებს — რეალური საიდუმლო არასოდეს ჩასვა კოდში.

  1. მიიღე წვდომის ტოკენი

    OAuth 2.0 client credentials; ტოკენი ხანმოკლეა და შეიცავს მხოლოდ ნებადართულ scope-ებს.

    curl — ტოკენი
    curl -X POST https://app.moacere.ge/oauth/token \
  -u "$MOACERE_CLIENT_ID:$MOACERE_CLIENT_SECRET" \
  -d grant_type=client_credentials \
  -d scope="documents:write envelopes:send"

  2. ატვირთე დოკუმენტი

    multipart ატვირთვა (PDF, DOC, DOCX, JPG, PNG — 25 მბ-მდე). გაგზავნამდე ფაილი მოწმდება და, საჭიროებისას, PDF-ად გარდაიქმნება.

    curl — ატვირთვა
    curl -X POST https://app.moacere.ge/api/v1/documents \
  -H "Authorization: Bearer $MOACERE_TOKEN" \
  -F file=@contract.pdf

  3. შექმენი კონვერტი

    დოკუმენტის ვერსია, მონაწილეები და მათი როლები, რიგითობა, ველები და ვადა — ან შაბლონის გამოყენება.

  4. გაგზავნე იდემპოტენტურად

    გაგზავნის წინ მოწმდება სავალდებულო ველები და პაკეტის ლიმიტი. Idempotency-Key სათაური იცავს ორმაგი გაგზავნისგან; იგივე გასაღები სხვა შიგთავსით აბრუნებს 409-ს.

    curl — გაგზავნა
    curl -X POST https://app.moacere.ge/api/v1/envelopes/$ENVELOPE_ID/send \
  -H "Authorization: Bearer $MOACERE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

  5. მიიღე webhook და ჩამოტვირთე ფაილები

    envelope.completed მოვლენის შემდეგ ჩამოტვირთე საბოლოო PDF და მტკიცებულებების ანგარიში (artifacts:read).

  6. მართე ინტეგრაცია

    დაუსრულებელი კონვერტის გამოთხოვა, საიდუმლოს როტაცია ან გაუქმება, მოხმარებისა და მიწოდების ჟურნალის ნახვა — აპლიკაციის მენიუში „დეველოპერებისთვის“.

Webhook-ები

ყოველი მოთხოვნა ხელმოწერილია HMAC-SHA256-ით და შეიცავს დროის ნიშანს. შეამოწმე ხელმოწერა ნედლ სხეულზე და უარყავი 300 წამზე ძველი მოთხოვნები.

სათაურები
Moacere-Signature: t=<unix>,v1=<hex HMAC-SHA256(secret, "<t>.<raw_body>")>
Moacere-Event-Id: <uuid>
Moacere-Event-Type: envelope.completed
  • ხელახალი მცდელობები: 1 წთ, 5 წთ, 30 წთ, 2 სთ, 6 სთ, 12 სთ, 24 სთ — შემდეგ მიწოდება ჩერდება
  • შესაძლოა მოვიდეს დუბლიკატი ან სხვა რიგით — გამოიყენე Moacere-Event-Id
  • payload მინიმალურია: მოვლენის ID, ტიპი, დრო და რესურსის ID — PDF და პერსონალური მონაცემები არ იგზავნება

მოვლენები

envelope.sent
დოკუმენტი გაიგზავნა
recipient.viewed
მონაწილემ გახსნა
recipient.signed
მონაწილემ ხელი მოაწერა
recipient.approved
მონაწილემ დაამტკიცა
envelope.completed
ყველა მოქმედება დასრულდა, ფაილები მზადაა
envelope.declined
მონაწილემ უარი თქვა
envelope.expired
ვადა გავიდა
envelope.recalled
გამგზავნმა გამოითხოვა
delivery.failed
შეტყობინება ვერ მიეწოდა

Scope-ები

documents:read
დოკუმენტების წაკითხვა
documents:write
დოკუმენტების ატვირთვა
envelopes:send
გაგზავნა და გამოთხოვა
templates:read
შაბლონების წაკითხვა
templates:write
შაბლონების მართვა
artifacts:read
ხელმოწერილი ფაილებისა და მტკიცებულებების ჩამოტვირთვა
webhooks:manage
webhook-ების მართვა

გჭირდება API წარმოებაში?

კორპორაციული პაკეტის პირობები ინდივიდუალურად თანხმდება.

დაგვიკავშირდი