Neidio i’r prif gynnwys

REST API Changelog

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

2027​

2027-10-27​

Adnodd TemplatePDF — Mae POST /api/v1/templatepdf/{pdfId}/preview/ yn disodli GET ar gyfer creu rhagolwg PDF gyda meysydd anfonwr wedi’u llenwi. Mae GET yn parhau i gael ei gefnogi.

2026​

2026-08-26​

Adnodd TemplatePDF — Pwynt diwedd newydd: GET /api/v1/templatepdf/{pdfId}/preview/ — yn dychwelyd rhagolwg PDF ar gyfer y templed penodedig.

2026-08-14​

Adnodd Element/Maes — GET /api/v1/document/{id}/fields/ — ychwanegwyd paramedr hidlo cwestiwn element_type. Gweler Get Document Fields.

2026-07-02​

Adnodd TemplatePDF — Pwynt diwedd newydd: GET /api/v1/templatepdf/{id}/component-token/ — yn dychwelyd tocyn cydran ar gyfer cofrestru cydran gwylio’r PDF.

2026-07-01​

Adnodd Llofnodwr — Pwynt diwedd newydd: GET /api/v1/signer/{id}/component-token/ — yn dychwelyd tocyn cydran ar gyfer cofrestru cydran llofnodi. Mae angen allwedd API sydd ddim yn hen ffasiwn a rhaid i’r grŵp fod wedi’i alluogi ar gyfer defnyddio cydrannau.

2026-05-20​

Adnodd Dogfen — Mae dolenni llofnodi llofnodwyr a ddychwelyd yn ymateb API bellach yn cael eu cadw fel dolenni fformat hen ffasiwn er mwyn cydymffurfio’n ôl wrth ddefnyddio llofnodi swmp neu lobïo.

2026-04-28​

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

2026-01-21​

Adnodd TemplatePDF — DELETE /api/v1/templatepdf/{id}/delete/ — diweddarwyd dileu ar gyfer dileu diogel. Yn dychwelyd gwall os yw’n methu (e.e. mae polisi cadw angen cymeradwyaeth eilaidd).

2026-01-06–07​

Adnodd Dogfen — Ychwanegwyd maes boole ‘append_history’ i anfon dogfennau ac ymateb manylion dogfen. Pan fo’n wir, mae’r dudalen hanes llofnodi yn cael ei atodi at y PDF cwblhawyd (yn efelychu ymddygiad presennol ‘append_pdf’).

Yn hen ffasiwn: mae meysydd sign_mouse, sign_type, sign_upload ar yr adnodd dogfen yn cael eu diddymu ac fe’u tynir yn ôl mewn diweddariad nesaf.

2025​

2025-12-18–19​

Adnodd Dogfen — Ychwanegwyd paramedr skip ar gyfer llofnodwyr wrth anfon dogfen. Mae gosod skip: true ar safle llofnodwr yn hepgor y derbynnydd hwnnw o’r anfon. Hefyd mae tystion sy’n dilyn llofnodwr a hepgorir yn cael eu hepgor yn awtomatig.

2025-10-30​

Adnodd Dogfen — Symudwyd creu polisi cadw o anfon API i’r llif llofnodi.

2025-10-08​

  • Adnodd Dogfen — Mae ymateb GET /api/v1/document/{id}/ bellach yn cynnwys array signer_objects ochr yn ochr â’r array presennol signers. Mae gan bob gwrthrych: firstname, lastname, email, tel, status, order, resource_uri, role, uuid.
  • Adnodd Llofnodwr — Ychwanegwyd maes role i ymateb llofnodwr ("signer", "approver", neu "witness").

2025-09-26​

  • Adnodd Dogfen — DELETE /api/v1/document/{id}/ — ychwanegwyd paramedr cwestiwn dewisol email=1 i anfon e-byst hysbysu ar ddileu.
  • Adnodd TemplatePDF — ychwanegwyd paramedr hide_sender_fields i bwynt golygu PDF.
  • Adnodd Element/Maes — mae'r chwilio pdftext a signertext bellach yn derbyn UUID yn ogystal â enw label.
  • Adnodd Llofnodwr — ychwanegwyd maes uuid i wrthrych ymateb llofnodwr.

2025-09-04​

Adnodd Dogfen — Pan nad yw neges yn cael ei ddarparu ar anfon, caiff templed neges diofyn y grŵp ei ddefnyddio’n awtomatig.

2025-08-22​

Adnodd Dogfen — Wrth anfon dogfen, caiff y PDF tarddiad ei gopïo o’r templed i gofnod y ddogfen.

2025-06-10​

Adnodd TemplatePDF — Pwynt diwedd newydd: POST /api/v1/templatepdf/{id}/archive/ — yn achub templed PDF.

2024​

2024-10-17​

Adnodd Dogfen — Tynnwyd paramedr llofnodwr append_to sydd wedi’i henffurfio. Nid oedd effaith ar y paramedr hwn ac fe’i tynnwyd.

2024-08-21​

  • Adnodd Defnyddiwr — Mae defnyddwyr a grëwyd gan API bellach yn cael cyfrinair parhaol (nid un dros dro sy’n gofyn am ailosod).
  • Adnodd Dogfen — Gwerthoedd llofnodwr elfen gweinyddol yn cael eu rheoli’n gywir ar gyfer mynegai llofnodwr 0.

2024-08-20​

  • Adnodd Dogfen — Mae paramedrau convert_sender_to_signer a strict_fields bellach yn derbyn true/"true"/1 (yn flaenorol dim ond boolean True).
  • Adnodd Llofnodwr/Elfen — Mae maes signer bellach yn gallu bod yn null; mae elfennau element_type: "admin" yn rhagosodedig i llofnodwr 0.
  • Rôlau — Mae rôlau API bellach yn cydamseru gyda’r console ar ôl creu dogfen.
  • Negeseuon gwall — Gwella neges gwall pan nad oes cysylltiad sefydliad gyda defnyddiwr.

2024-08-19​

**Adnodd Grŵp (Tab) ** — POST /api/v1/group/ — mae name yn unig sydd ei angen yn y maes. Mae xframe_allow bellach yn paramedr dewisol.

2024-07-16​

Adnodd Dogfen — Mae paramedr cc bellach yn derbyn y gwerth "default" i ddefnyddio rhestr e-bost CC diofyn y grŵp.

2024-06-14​

Adnodd Dogfen — Ychwanegwyd meysydd pdf_password a pdf_password_type i ymateb manylion dogfen.

2024-02-20​

Adnodd TemplatePDF — GET /api/v1/templatepdf/{id}/ (lawrlwythiad PDF) — ychwanegwyd paramedr cwestiwn returnAsJson i ddychwelyd y PDF fel ymateb JSON wedi’i amgodio base64 yn hytrach na lawrlwythiad ffeil.

2024-02-09​

Adnodd TemplatePDF — Cywiriad teipio yn ymateb returnAsJson: documet_uri → document_uri.

2024-01-26​

Adnodd TemplatePDF — POST /api/v1/templatepdf/ — ychwanegwyd paramedr cwestiwn 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​

Adnodd Dogfen — Gwelliant perfformiad: uwchraddio GET /api/v1/document/ (ymholiad cyfrif yn gyflymach).

2023​

2023-09-27​

Adnodd Dogfen — Ychwanegwyd dau baramedr hidlo cwestiwn newydd i GET /api/v1/document/:

  • created_gt — hidlo dogfennau wedi’u creu ar ôl dyddiad a amser penodol (ISO 8601)
  • modified_gt — hidlo dogfennau wedi’u haddasu ar ôl dyddiad a amser penodol (ISO 8601)

Mae URLau tudalennu next/previous bellach yn cynnwys holl baramedrau hidlo gweithredol yn gywir.

2023-08-08​

Adnodd Dogfen — Ychwanegwyd paramedr hidlo sentUserId i GET /api/v1/document/.

2023-07-07​

Adnodd Defnyddiwr — Mae defnyddwyr gweinyddwr bellach yn gallu creu is-defnyddwyr drwy’r API.

2023-05-31​

Adnodd Dogfen — Nid yw tystion bellach yn cael eu cynnwys yn y rhestr derbynwyr atgoffa diofyn.

2023-04-17​

  • Adnodd Llofnodwr — Ychwanegwyd maes rejection_reason i ymateb llofnodwr.
  • Enwi — Cywiriadau cysondeb ar enwi meysydd ar draws yr API.

2023-03-02​

Webhooks — Estynedig y hyd uchaf ar faes callback_url o 200 i 500 o gymeriadau.

2023-01-17​

Adnodd Dogfen — Ychwanegwyd meysydd tag2 a tag3 (yn ogystal â tag/tag1 presennol) i anfon dogfen ac ymateb.

2022​

2022-11-14–15​

Adnodd Dogfen — Cynyddwyd y nifer uchaf o feysydd a ganiateir fesul dogfen.

2022-11-02–03​

Webhooks — Ychwanegwyd mathau digwyddiad webhook newydd. Diweddarwyd eitemau usercallback.

2022-09-09​

Adnodd Dogfen — Ychwanegwyd paramedr cais message_template i bennu templed neges wrth anfon.

2022-05-12​

Adnodd Element/Maes — Ychwanegwyd maes no_pdf: opsiwn i nodi maes fel nad yw’n cael ei arddangos ar y PDF terfynol.

2022-04-20​

  • Adnodd Dogfen — Nid oes angen role mwyach yn y geiriadur llofnodwr wrth anfon dogfen gan ddefnyddio TemplatePDF.
  • Adrodd gwallau — Gwella negeseuon ymateb gwall ar draws yr API.

2022-04-06​

Adnodd Element/Maes — Ychwanegwyd math dilysu regex (math dilysu 93) ar gyfer gwerthoedd maes.

2022-02-24​

Adnodd Element/Maes — Ychwanegwyd maes label_extra.

2022-02-22​

Adnodd TemplatePDF — Ychwanegwyd opsiwn force_download wrth gael drafft PDF.

2022-02-17​

Adnodd Dogfen — Ychwanegwyd cefnogaeth reviewers wrth anfon dogfen.

2022-02-15​

Adnodd Dogfen — Ychwanegwyd cefnogaeth maes honorifics ar POST dogfen.

2021​

2021-11-30​

Adnodd Dogfen — Pwynt diwedd newydd: GET /api/v1/document/{id}/auditlog/ — yn dychwelyd log archwilio ar gyfer dogfen.

2021-10-31​

Adnodd Dogfen — Mae ymateb GET /api/v1/document/ bellach yn cynnwys maes tag.

2021-10-30​

Adnodd Dogfen — Mae ymateb GET /api/v1/document/ bellach yn cynnwys maes location.

2021-10-28​

Adnodd Dogfen — Ychwanegwyd cefnogaeth dilysu maes wrth anfon dogfennau drwy’r API.

2021-10-27​

Adnodd Dogfen — Pwynt diwedd newydd: GET /api/v1/document/{id}/fields/ — yn dychwelyd data maes ar gyfer dogfen.

2021-10-25​

Adnodd Dogfen — Ychwanegwyd cefnogaeth bundle. Ychwanegwyd paramedr convert_sender_to_signer wrth anfon dogfen.

2021-08-17​

Adnodd TemplatePDF — Ychwanegwyd maes archive_upon_send i restr meysydd adnodd PDF templed.

Export This Article

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