Neidio i’r prif gynnwys

REST API Changelog

Newidiadau i REST API v1 (/api/v1/).

2026​

2026-08-26​

TemplatePDF resource — Pwynt terfynol newydd: GET /api/v1/templatepdf/{pdfId}/preview/ — yn dychwelyd rhagolwg PDF ar gyfer y templed penodol.

2026-08-14​

Element/Field resource — GET /api/v1/document/{id}/fields/ — ychwanegwyd paramedr hidlo ymholiad element_type. Gweler Get Document Fields.

2026-07-02​

TemplatePDF resource — Pwynt terfynol newydd: GET /api/v1/templatepdf/{id}/component-token/ — yn dychwelyd tocyn cydran gwylio ar gyfer mewnosod y cydran gwylio PDF.

2026-07-01​

Signer resource — Pwynt terfynol newydd: GET /api/v1/signer/{id}/component-token/ — yn dychwelyd tocyn cydran ar gyfer mewnosod y cydran llofnodi. Mae angen allwedd API nad yw’n hen ffasiwn a rhaid i’r grŵp fod wedi'i alluogi ar gyfer defnydd cydran.

2026-05-20​

Document resource — Mae dolenni llofnodi ar gyfer y llofnodydd a ddychwelir yn ymateb API bellach yn cael eu cadw fel dolenni fformat hen ffasiwn ar gyfer gydnawsedd ôl-ddwylo wrth ddefnyddio llofnodi swmp/nefoedd.

2026-04-28​

Authentication — Mae cynllun allwedd API newydd bellach ar gael. Mae’r allweddi presennol yn parhau i weithio. Argymhellir yn gryf i ddatblygwyr uwchraddio — gweler developer.legalesign.com am fanylion.

2026-01-21​

TemplatePDF resource — DELETE /api/v1/templatepdf/{id}/delete/ — diweddariad i ddileu i ddileu'n ddiogel. Yn dychwelyd gwall os yw'n methu (e.e. mae polisi cadw'n gofyn am gymeradwyaeth eilaidd).

2026-01-06–07​

Document resource — Ychwanegwyd cae boolean append_history i ymateb anfon a manylion dogfen. Pan fo true, mae’r dudalen hanes llofnodi yn cael ei ychwanegu at y PDF cwblhawyd (yn adlewyrchu’r ymddygiad presennol append_pdf).

Yn cael ei ddiddymu: mae meysydd sign_mouse, sign_type, sign_upload ar y resource dogfen yn cael eu diddymu ac fe’u tynnir ymlaen llaw.

2025​

2025-12-18–19​

Document resource — Ychwanegwyd paramedr skip ar gyfer llofnodwyr wrth anfon dogfen. Mae gosod skip: true ar sefyllfa llofnodi yn hepgor y derbynnydd hwnnw o’r anfon. Mae tystion sy’n dilyn llofnodydd a hepgorer hefyd yn cael eu hepgor yn awtomatig.

2025-10-30​

Document resource — Symudwyd creu polisi cadw o anfon API i lif llofnodi.

2025-10-08​

  • Document resource — Mae ymateb GET /api/v1/document/{id}/ bellach yn cynnwys arae signer_objects ochr yn ochr â’r arae signers presennol. Mae pob gwrthrych yn cynnwys: firstname, lastname, email, tel, status, order, resource_uri, role, uuid.
  • Signer resource — Ychwanegwyd maes role i ymateb llofnodi ("signer", "approver", neu "witness").

2025-09-26​

  • Document resource — DELETE /api/v1/document/{id}/ — ychwanegwyd paramedr ymholiad dewisol email=1 i anfon e-byst hysbysiad ar ddileu.
  • TemplatePDF resource — Ychwanegwyd paramedr hide_sender_fields i bwynt edit PDF.
  • Element/Field resource — Mae chwiliadau pdftext a signertext bellach yn derbyn UUID yn ogystal â’r enw label.
  • Signer resource — Ychwanegwyd maes uuid i wrthrych ymateb llofnodi.

2025-09-04​

Document resource — Pan na ddarperir neges ar anfon, defnyddir templed neges ddiofyn y grŵp yn awtomatig.

2025-08-22​

Document resource — Wrth anfon dogfen, caiff y PDF tarddiad ei gopïo o’r templed i’r cofnod dogfen.

2025-06-10​

TemplatePDF resource — Pwynt terfynol newydd: POST /api/v1/templatepdf/{id}/archive/ — yn halogi templed PDF.

2024​

2024-10-17​

Document resource — Tynnwyd y paramedr llofnodi append_to sydd wedi'i ddiddymu. Nid oedd gan y paramedr hwn unrhyw effaith a chafodd ei ddileu.

2024-08-21​

  • User resource — Mae defnyddwyr a grëwyd gan API bellach yn cael cyfrinair parhaol (nid un dros dro sy’n gofyn am ailosod).
  • Document resource — Trin gwerthoedd llofnodi elfennau gweinyddol yn iawn ar gyfer mynegai llofnodi 0.

2024-08-20​

  • Document resource — Mae paramedrau convert_sender_to_signer a strict_fields bellach yn derbyn true/"true"/1 (yn flaenorol dim ond boolean True).
  • Signer/Element resource — Mae’r maes signer bellach yn alluogi gwerthoedd gwag; mae elfennau element_type: "admin" yn cael gwerth diofyn llofnodi 0.
  • Roles — Mae rolau API bellach yn cyd-synchroni gyda’r console ar ôl creu dogfen.
  • Error messages — Gwall gwell pan nad oes gan y defnyddiwr gysylltiad sefydliad.

2024-08-19​

Group (Tab) resource — POST /api/v1/group/ — name yw’r unig faes gofynnol bellach. Mae xframe_allow yn paramedr dewisol.

2024-07-16​

Document resource — Mae paramedr cc bellach yn derbyn y gwerth "default" i ddefnyddio rhestr CC e-bost ddiofyn y grŵp.

2024-06-14​

Document resource — Ychwanegwyd meysydd pdf_password a pdf_password_type i ymateb manylion dogfen.

2024-02-20​

TemplatePDF resource — GET /api/v1/templatepdf/{id}/ (lawrlwythiad PDF) — ychwanegwyd paramedr ymholiad returnAsJson i ddychwelyd y PDF fel ymateb JSON wedi'i enkodeiddio base64 yn hytrach na lawrlwytho ffeil.

2024-02-09​

TemplatePDF resource — Cywiriwyd camgymeriad yn ymateb returnAsJson: documet_uri → document_uri.

2024-01-26​

TemplatePDF resource — POST /api/v1/templatepdf/ — ychwanegwyd paramedr ymholiad dewisol returnAsJson. Pan fo wedi’i osod, mae’r corff ymateb yn cynnwys { resource: { uid, status_uri, document_uri } } yn lle 201 gwag.

2024-01-21​

Document resource — Gwelliant perfformiad: diweddariad GET /api/v1/document/ (ymholiad cyfrif yn gyflymach).

2023​

2023-09-27​

Document resource — Ychwanegwyd dwy baramedr hidlo ymholiad newydd i GET /api/v1/document/:

  • created_gt — hidlo dogfennau a grëwyd ar ôl dyddiad a amser penodol (ISO 8601)
  • modified_gt — hidlo dogfennau a addaswyd ar ôl dyddiad a amser penodol (ISO 8601)

Mae URLs tudalen “nesaf”/“blaenorol” bellach yn cynnwys pob paramedr hidlo gweithredol yn iawn.

2023-08-08​

Document resource — Ychwanegwyd paramedr hidlo sentUserId i GET /api/v1/document/.

2023-07-07​

User resource — Gall gweinyddwyr bellach greu is-ddefnyddwyr trwy'r API.

2023-05-31​

Document resource — Nid yw tystion bellach yn cael eu cynnwys yn rhestr y derbynwyr atgoffa diofyn.

2023-04-17​

  • Signer resource — Ychwanegwyd maes rejection_reason i ymateb llofnodi.
  • Naming — Cywiriadau cydlyniant ar enwau meysydd ar draws y API.

2023-03-02​

Webhooks — Estynnwyd hyd uchaf maes callback_url o 200 i 500 nod.

2023-01-17​

Document resource — Ychwanegwyd meysydd tag2 a tag3 (ymysg y meysydd presennol tag/tag1) i anfon a ymateb dogfen.

2022​

2022-11-14–15​

Document resource — Cynyddu’r nifer uchaf o feysydd a ganiateir fesul dogfen.

2022-11-02–03​

Webhooks — Ychwanegwyd mathau digwyddiadau webhook newydd. Wedi diweddaru itemau usercallback.

2022-09-09​

Document resource — Ychwanegwyd paramedr cais message_template i nodi templed neges wrth anfon.

2022-05-12​

Element/Field resource — Ychwanegwyd maes no_pdf: opsiwn i nodi maes fel na fydd yn cael ei arddangos ar y PDF terfynol.

2022-04-20​

  • Document resource — Nid yw role yn ofynnol mwyach yn y geiriadur llofnodi wrth anfon dogfen gan ddefnyddio TemplatePDF.
  • Error reporting — Gwelliannau i negeseuon ymateb gwall ar draws yr API.

2022-04-06​

Element/Field resource — Ychwanegwyd math dilysu regex (math dilysu 93) ar gyfer gwerthoedd maes.

2022-02-24​

Element/Field resource — Ychwanegwyd maes label_extra.

2022-02-22​

TemplatePDF resource — Ychwanegwyd opsiwn force_download ar gyfer cael drafft PDF.

2022-02-17​

Document resource — Ychwanegwyd cefnogaeth reviewers wrth anfon dogfen.

2022-02-15​

Document resource — Ychwanegwyd cefnogaeth maes honorifics ar POST dogfen.

2021​

2021-11-30​

Document resource — Pwynt terfynol newydd: GET /api/v1/document/{id}/auditlog/ — yn dychwelyd log archwilio ar gyfer dogfen.

2021-10-31​

Document resource — Mae ymateb GET /api/v1/document/ bellach yn cynnwys maes tag.

2021-10-30​

Document resource — Mae ymateb GET /api/v1/document/ bellach yn cynnwys maes location.

2021-10-28​

Document resource — Ychwanegwyd cefnogaeth dilysu maes wrth anfon dogfennau drwy API.

2021-10-27​

Document resource — Pwynt terfynol newydd: GET /api/v1/document/{id}/fields/ — yn dychwelyd data maes ar gyfer dogfen.

2021-10-25​

Document resource — Ychwanegwyd cefnogaeth bundle. Ychwanegwyd paramedr convert_sender_to_signer wrth anfon dogfen.

2021-08-17​

TemplatePDF resource — Ychwanegwyd maes archive_upon_send i restr meysydd templed PDF.

Diweddarwyd ddiwethaf ar

Export This Article

Save a copy of this page as PDF or plain text.