Sleamhnú go príomh-ábhar

Ceardlann Túsghlacadh

leide

Ag baint úsáide as Cursor, Claude, nó uirlis códúcháin AI eile? Ceangail é leis na doiciméid Legalesign chun cabhair eolasach comhthéacs a fháil agus tú ag leanúint an cheardlanna seo.

Sa cheardlann seo críochnóidh tú na príomhriachtanais API a theastaíonn ó fhormhachaitheoirí de ghnáth ó chomhtháthú sínithe leictreonacha - doiciméad a uaslódáil agus é a sheoladh chun síniú.

Tá API Legalesign scálaithe, ilúsáideach, agus tástáilte i dtáirgeadh sna córais chustaiméirí againn le blianta fada. Is féidir leat é a úsáid do dhoiciméad aonshíntithe simplí, nó doiciméid a sheoladh chun fianaise nó ceadúnais a fháil, optamaithe do baisceanna, le foirmeacha agus níos mó. Is féidir leat comhtháthú a dhéanamh chun críocha amháin, nó é a chur isteach i do bhogearraí do do chustaiméirí - féach ar chomhtháthuithe.

Déanann an REST API an chuid is mó de na feidhmeanna agus is é an bealach is éasca tús a chur leis. Más gá duit níos mó féach ar an gcomhéadan GraphQL. Tá Legalesign dírithe ar API leis an gcéad dul síos le GraphQL. Is féidir leat úsáid a bhaint as an dá cheann, de réir mar is fearr leat.

Leanfaidh muid na céimeanna seo:

  1. Cruthaigh cuntas + Eochair API (féach Faigh deimhnithe maidir le rochtain API).
  2. Deimhníonn tú go n-oibríonn do chuid creidiúnaithe agus faigh d’aitheantas foirne.
  3. Uaslódáil doiciméad tríd an aip gréasáin.
  4. Seol é sin chun síniú tríd an API.
  5. Íoslódáil é tar éis sínithe.
  6. Uaslódáil doiciméad tríd an API.

Tá REST API Legalesign éasca le húsáid. Cuimsíonn an tagairt theicniúil eagarthóir cód. Is féidir leat iarratais a dhéanamh díreach ón tagairt theicniúil le do eochair API, ach mura bhfuil sin oiriúnach is féidir leat cóipeáil agus greamú go díreach isteach i do chód.

Íomhá Ginteoir Cód Figiúr 1: Eagarthóir Cód REST API.

Leabharlanna Cliant

Nó don chomhéadan GraphQL Node.js

leide

Molaimid do fhorbróirí oibriú go díreach leis an API seachas leis na SDKanna. Chun cabhrú, tá gineadóir cód a ghearradh agus a ghreamú sa sonraíocht theicniúil, agus is féidir le do AI samplaí a tháirgeadh go tapa ag úsáid an shonraigh OpenAPI. Cén fáth? Tá níos mó feidhmiúlachta ag an API bunaidh ná na SDKanna, beidh tú ag iarraidh eolas a bheith agat ar na foirceannáin a úsáidfidh tú ar aon nós, seachnóidh tú iomarcaíocht agus spleáchais, agus - bunaithe ar ár dtaithí - déanfaidh tú é níos tapúla ar fad.

1. Cuntas a chruthú

Téigh chuig [síniú suas legalean] (https://legalesign.com/landing/free-trial/) agus lean an próiseas chun cuntas a chruthú.

Iarrfar ort foireann a chruthú. Is iad na foirne na bloic tógála Legalesign. Tarlaíonn gach próiseáil doiciméid i bhfoireann. Caithfidh tú tagairt a dhéanamh do do fhoireann sna formhór de ghlaonna API.

eolas

Tá 'foireann' agus 'grúpa' mar an gcéanna. San aip gréasáin labhraímid faoi 'fhoirne', ach sa scéim API is 'grúpa' atá ann.

Socruithe API

Téigh go dtí an Painéal API. Gineadh do chreidiúnaithe API sa chuid Eochair API.

Tóg nóiméad chun an Taiscéal Forbróra a athbhreithniú.

Sandbox

Sa Roinn Timpeallachta, taispeánann foláireamh an bhfuil tú i mód taoibh nó i mód táirgeachta.

Cuirtear teorainn 100 glao san uair i mód taoibh. Níl aon srianta ar sheoltaí ríomhphoist faighteoirí.

Nuair atá do chomhtháthú réidh: bog go mód táirgeachta.

leide

Cruthaigh foireann eile. Úsáid do chéad fhoireann go dtí an fhorbairt agus foireann nó foirne eile don táirgeadh. Abair leis an tacaíocht ainm do fhoireann forbartha chun í a eisiamh ó bhilleáil.

Eochair API

Sa chuid Eochair API feicfidh tú sonraí do eochracha API. Taispeánfar duit an eochair féin amháin nuair a chruthaíonn tú ceann.

Tá samplaí déan-greamaigh sa rannán Túsghlacadh chun do eochair a thástáil.

Scáileán Roinn Eochair API

Webhooks & Logaí

Cuir webhooks leis (dá gcluasóirí do imeachtaí Legalesign) agus athbhreithnigh do logaí.

Scáileán Roinn Webhooks

2. Iarratas GET rathúil

Is é an URL fréimhe i gcónaí: https://eu-api.legalesign.com/

Tosaigh le hiarratas GET chun a dhearbhú go bhfuil do chreidiúnaithe ag obair. Cuir your_api_key in ionad do eochair ón Taiscéal Forbróra.

Úsáidtear Curl sna samplaí, agus is féidir leat aistriú idir cURL, Node.js, Python, C#, agus Go ag baint úsáide as na cluaisíní thíos.

curl -H "Authorization: Bearer your_api_key" -H "Content-Type: application/json" -X GET https://eu-api.legalesign.com/api/v1/group/

Doiciméadacht API: Tagairt API grúpa GET.

Nuair a rithfidh tú an fiosrúchán thuas, feicfidh tú do ghrúpaí á gcuardach ar ais i JSON. Rathaíocht. 👏

Tá 'URI acmhainní' i sonraí an fhreagra do do ghrúpa agus tá cuma ar an méid mar /api/v1/group/:groupId/. Déan nóta de seo, beidh sé ag teastáil ó chuid is mó den API glaonna.

leide

Beidh an URI acmhainní formáidithe i gcónaí san aon fhormáid chéanna. Do PDF bheadh sé '/api/v1/templatepdf/:pdfId/', don doiciméad seolta beidh sé '/api/v1/document/:documentId/'. Tabhair faoi deara go gcríochnaíonn na URI go léir le sliotar. Tá sé seo fíor freisin do na URLanna d’fhógraí API, deireadh a chur leo i gcónaí le sliotar.

Mura raibh an iarratas GET rathúil seiceáil gur:

  • tá do cheannlíne Authorization formáidithe i gceart (tosaíonn le Bearer ),
  • tá ceannlíne Content-Type agat le haghaidh application/json, agus
  • críochnaíonn do URL le sliotar.

Féach freisin ar réiteach fadhbanna.

3. Uaslódáil doiciméad tríd an aip gréasáin

Chun tús a chur, uaslódálfaimid doiciméad trí úsáid an aip gréasáin agus seolfaimid é tríd an API. Déanfaimid iniúchadh ar [conas doiciméad a uaslódáil tríd an API] (#6-upload-a-pdf) níos déanaí.

Téigh chuig an aip gréasáin agus uaslódáil doiciméad. Cuir ról sínitheora amháin leis agus tarraing réimse sínithe. Léireoidh an leathanach eagarthóra an bhfuil an doiciméad 'bailí' (mar shampla 'neamhdhleathach' b'fhéidir má chuireann tú ról sínitheora leis gan réimse sínithe gaolmhar).

Ar eagarthóir an fhoirm, cóipeáil an ID fada alfachomhthreomhmhéadrach ón URL, díchódáil é mar base64 agus scaoil na trí litreacha tosaigh (ba cheart go mbeadh 'tpl' iontu). Is UUID an chuid atá fágtha agus tá sé mar do ID.

I dtéarmaí REST API is é an URI acmhainní doiciméad seo /api/v1/templatepdf/UUID/.

Foghlaim níos mó faoi IDs gréasáin agus API.

Tá ár bhfoclóir mar a leanas: doiciméad uaslódáilte is 'teimpléad' ann, agus nuair a sheolann tú ceann cruthaíonn tú 'doiciméad'.

leide

Má theastaíonn uait teimpléad a chartlannú nuair a sheolfar an doiciméad socraigh 'archive_upon_send' mar airíonna san iarratas uaslódála. Mura dteastaíonn uait go bhfeicfear an teimpléad ar chor ar bith agus go dteastaíonn díothú ón gcóras tar éis é a sheoladh tabhair dó an teideal '[deleted]' - bainfidh ár gcórais glantacháin é agus scriosfaidh siad é tar éis lá nó dhó. Is féidir leat amanna coinníollacha gearrshaolacha a shocrú freisin ag leibhéal an ghrúpa - foghlaim níos mó.

4. Seol doiciméad le haghaidh síniú

Anois seolfaimid é tríd an API. Bain úsáid as na cluaisíní thíos chun an iarratas a fháil i do theanga roghnaithe.

curl -H "Authorization: Bearer your_api_key" -H "Content-Type: application/json" -X POST --data '{ "group": "/api/v1/group/[:groupId]/", "name": "Name of doc", "templatepdf": "/api/v1/templatepdf/UUID/", "signers": [{"firstname": "Joe", "lastname": "Bloggs", "email": "[your@email.com]", "order": 0 }], "do_email": true }' https://eu-api.legalesign.com/api/v1/document/

Nuashonraigh na lúibíní cearnacha go léir. Tagairt API chun doiciméad a sheoladh.

leide

Nuair a thugann tú cuairt ar an doiciméad tagartha maidir le doiciméad a sheoladh féach leat tríd na hairíonna uile a d'fhéadfadh a bheith ann. Feicfidh tú go leor a chabhróidh le gnéithe praiticiúla comhtháthaithe - clibeanna do do thagairtí féin agus IDs (a aisíocann duit trí webhooks), atreorú do shínitheoirí, téacs saincheaptha a chur isteach sa PDF, agus níos mó.

Tabharfaidh gairid amháin cód stádais 201 ar ais.

Faigh ID doiciméid nua seolta

Is é an tábhachtach is mó sa fhreagra ná ceannlíne an luchtaigh. Tá an ID nua doiciméid ann.

leide

Bain úsáid as hairíonna clibe doiciméid agus cuir do thagairtí féin leis chun é a éascú ceangail leis an mbunachar sonraí féin agat.

Beidh cuma ar an gceannlíne luchtaithe mar /api/v1/status/:documentId/.

Cuireann an URI 'stádas' sraith ghearr (agus tapa le fiosrú) airíonna an doiciméid ar ais.

Chun gach rud a iarraidh as doiciméad bain úsáid as /api/v1/document/:documentId/.

eolas

Má theipeann ar iarratas go minic bíonn faisnéis earráide istigh i mBODHCHÓIP an fhreagra. Mura bhfaigheann tú stádas rath, seiceáil an BODHCHÓIP le téacs míniúcháin. Féach freisin ar réiteach fadhbanna.

Foghlaim níos mó faoi ghlao API Doiciméid a Sheoladh.

5. Íoslódáil an doiciméad sínithe

Leis an ID don doiciméad seolta a fuair tú thuas, déan iarratas íoslódála PDF i do theanga is fearr leat:

curl -H "Authorization: Bearer your_api_key" -o download.pdf -X GET https://eu-api.legalesign.com/api/v1/pdf/:documentId/

Tagairt API Íoslódála PDF.

Tá an dáta raon PDF i mBODHCHÓIP an fhreagra. Cuirfidh an t-ordú curl '-o' BODHCHÓIP an fhreagra díreach isteach i gcomhad.

Déileálann go leor leabharlanna REST nó HTTP le réada freagra HTTP amhail is dá mba gcomhaid iad agus dá bhrí sin sábhálfaidh tú d'fhoinse freagra díreach mar chomhad gnáth.

leide

Bain úsáid as webhooks chun fógra a fháil faoi imeacht sínithe agus ansin an doiciméad a íoslódáil. Féach webhooks.

6. Uaslódáil PDF

Cliceáil anseo chun PDF samplach le tag téacs a íoslódáil, beidh níos mó faoi réimsí foirme PDF le leanúint.

Don ghlao seo, tiontaigh do PDF ina shreang comhbhrúite bunaithe ar base64. Ní dhéantar é seo i gceart laistigh den ghineadóir cód sna doiciméid. Ina áit sin cóipeáil an phsudóchód seo agus déanfaidh d’AI cairdiúil é a thiontú go teanga atá uait:

$data = (
'group': '/api/v1/group/:groupId/',
'title': 'title of pdf',
'pdf_file': base64encode(open('/path/to/file','rb')),
'process_tags': true
)
$headers = (
'Authorization': 'Bearer your_api_key',
'Content-Type': 'application/json'
)
response = httplibrary.post('https://eu-api.legalesign.com/api/v1/templatepdf/', jsonEncode($data), $headers)
assert response.status == 201

pdfId = response.headers['location']

Tagairt API Uaslódála PDF.

Mar is gnách, tabharfaidh freagra POST rathúil stádas '201' agus beidh an ID nua i gceannlíne 'location' an fhreagra.

assert response.status == 201
pdfId = response.headers['location']

Beidh cuma ar do URI acmhainní PDF mar /api/v1/templatepdf/:pdfId/.

Seol an PDF nua

Téigh ar ais chuig an gcód a d’úsáid tú chun do chéad doiciméad a sheoladh, agus déan athrú ar an luach templatepdf.

Déanaimis an t-iarratas arís agus sin tú, chuir tú do PDF amach le sínithe.

Sula dtosaíonn tú ag códú, áfach, léigh ar aghaidh chun tuilleadh eolais a fháil faoi réimsí PDF.

Cad faoi réimsí PDF?

Conas a fhiosraíonn Legalesign cá bhfuil an duine ag teastáil a shíniú ar an PDF, nó altanna le hathrú nuair a chuirtear ar fáil é? Is é an freagra go bhfuil ár PDF réamhullmhaithe le clibeanna: chuir muid clib téacs Legalesign taobh istigh den PDF agus shocraigh muid 'process_tags' mar fíor san iarratas uaslódála PDF.

[Íoslódáil PDF samplach le tag téacs] (https://static.legalesign.com/tutorialQuickstartPdf.pdf).

Is téacs formáidithe go speisialta iad clibeanna téacs le cur isteach i PDF. Déanfaidh Legalesign an téacs i do chomhad a pharsáil, agus cuirfidh sé na clibeanna in ionad réimsí síniú agus foirme. Do shíntóir amháin, níl le déanamh agat ach seo a chur leis: <<t=signature>>. Aithneoidh Legalesign é agus cuirfidh sé an síniú ansin. Foghlaim faoi chlibeanna téacs.

Tá clibeanna téacs beagán de chuar oiliúna agus teastaíonn trialacha agus earráidí chun iad a thuiscint. Tá modhanna eile leagtha amach thíos, ach faighfidh tú an cumas iomlán ó chórais foirme Legalesign leo. Bain úsáid as an aip gréasáin chun na clibeanna a thástáil. Déan teagmháil le tacaíocht chun cabhair agus samplaí a fháil.

Seo 4 bealaí eile chun réimsí a chur le chéile:

1. An leagan is éasca/is gasta. Socraigh do PDF ag baint úsáide as aip gréasáin Legalesign.

Tar éis duit PDF a uaslódáil téigh chuig an gcomhéadan eagarthóra áit ar féidir leat réimsí foirme a tharraingt agus a scaoileadh.

Tarraing agus scaoil síniú, ansin tabhair faoi deara an ID comhbhrúite sa seoladh gréasáin. Beidh cuma air ar nós 'dHBsMTRlZTQ0ZWUtZGE0Ni0xMWVmLTllZmUtMDI5ZGQ0ODkzZGRk'.

Díchódáil an ID seo mar base64 agus feicfidh tú gur UUID í, roimh ainm 'tpl'. Is é an cuid UUID (cuir 'tpl' as) atá do pdfID. Foghlaim níos mó faoi IDs Legalesign.

Beidh cuma ar do URI acmhainní PDF API mar - /api/v1/templatepdf/:pdfId/.

Cuir isteach sin mar mhaoin 'templatepdf' sa ghlao doiciméid a sheoladh.

eolas

Má tá sé i gceist agat an PDF seo a sheoladh níos mó ná uair amháin, cinntigh nach bhfuil 'Auto archive' ar siúl. Féach conas

2. Bain úsáid as comhordanáidí x/y do réimsí.

Is é an bealach is simplí chun tosú leis na comhordanáidí x/y ná PDF a chur ar bun san aip gréasáin agus ansin iarratas API a dhéanamh chun na réimsí sin a fháil (GET Fields PDF - /api/v1/templatepdf/:pdfId/fields/).

Is é an struchtúr JSON a fhaigheann tú ar ais an chuma chéanna le scéim JSON is gá duit chun réimsí a chruthú freisin.

Bain úsáid as mar theimpléad. Athraigh luachanna agus déan POST ar ais chuig an bpointe deiridh chéanna (ag athrú ID PDF de réir mar is gá). Cruthaigh pointe deiridh réimse PDF.

3. Cuimsigh ár leathanach eagarthóra PDF. NUA!

Úsáid ár gcomhpháirt eagarthóra chun ár n-eagarthóir PDF a chur isteach díreach i do aip féin. Foghlaim níos mó faoi chomhpháirt eagarthóra doiciméad.

4. Réimsí Foirme PDF NUA!

Má tá réimsí Foirme PDF gnáth ag do PDF, is féidir le Legalesign iad a iompórtáil go huathoibríoch.

Obair mhaith ort!

Sa cheardlann seo fuair tú creidiúnaithe API, d'fhiafraigh tú ar do ghrúpa(í) go rathúil, sheol tú doiciméad le haghaidh sínithe ag úsáid HTML agus PDF, agus íoslódáil tú doiciméad sínithe.

Obair mhaith ort! Táimid anseo chun cabhrú, déan teagmháil le tacaíocht más gá aon chabhair.

leide

Go deas, shroiche tú an deireadh - go raibh maith agat as an léamh seo. Ár n-iarratas deiridh, agus leide, bunaithe ar blianta d’eispéireas forbróirí ag comhtháthú leis an API seo, ná glac nóiméad chun na hairíonna uile ar an bpointe deiridh chun doiciméad a chruthú a léamh (agus cliceáil isteach chun a fheiceáil cad atá i 'síntóirí', 'téacs pdf' agus 'téacs sínitheoir') - is é an glao is tábhachtaí i do chomhtháthú é. Cruthaigh doiciméad sínithe.

Céimeanna Eile: