Sleamhnú go príomh-ábhar

Treoirtóireacht Thapa

leide

Ag baint úsáide as Cursor, Claude, nó uirlis chódaithe AI eile? Ceangail í le doiciméid Legalesign le haghaidh cúnamh comhthéacsúla agus tú ag leanúint an treorach seo.

Sa treoir seo críochnóidh tú na glaonna API tábhachtacha a théann mórchuid na bhforbróirí i dtaithí orthu ó chomhtháthú eSínithe - doiciméad a uaslódáil agus é a sheoladh le sínithe.

Tá API Legalesign inscálaithe, ilúsáidte, agus tástáilte i bpróisis táirgthe i gcórais ár gcliant le blianta fada. Is féidir leat é a úsáid do dhoiciméad le sínithe amháin, nó doiciméid a sheoladh le haghaidh fianaise nó ceadúnais, optamaithe do bhailte, le foirmeacha agus breis. Is féidir leat é a chomhtháthú le haghaidh cuspóir amháin nó é a phróiseáil laistigh de do bhogearraí do do chliaint - féach comhtháthaithe.

Déanann an REST API an-chuid feidhmeanna agus is é an bealach is éasca tús a chur leis. Má theastaíonn uait níos mó, féach ar an comhéadan GraphQL. Tá Legalesign bunaithe ar API leis an GraphQL. Is féidir leat aon cheann a úsáid, de réir mar is mian leat.

Leanfaidh muid na céimeanna seo:

  1. Cruthaigh cuntas + Eochair API (féach Faigh fíoraithe don rochtain API).
  2. Déan dearbhú go n-oibríonn na dintiúirí agus faigh do ID foirne.
  3. Uaslódáil doiciméad tríd an aip ghréasáin.
  4. Seol é sin chun sínithe tríd an API.
  5. Íoslódáil é tar éis an tsí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 iarratais a dhéanamh díreach ón tagairt theicniúil le do eochair api, ach murach sin cóipeáil agus greamaigh go díreach isteach i do chód.

Íomhá Gineadóir Cód Fig. 1: Eagarthóir Cód REST API.

Leabharlanna Cliant

Nó don chomhéadan GraphQL Node.js

leide

Molaimid do fhorbróirí oibriú díreach leis an API seachas leis na SDKanna. Chun cabhrú, tá gineadóir cód cut-and-paste sa sonraíocht theicniúil, agus d’fhéadfadh do AI samplaí a ghiniúint go tapa ag baint úsáide as an [sainmhíniú OpenAPI] (https://raw.githubusercontent.com/legalesign/Legalesign-V1-OpenAPI3/refs/heads/master/legalesign-api-v1.yaml). Cén fáth? Tá níos mó feidhmiúlachta san API bunaidh ná sna SDKanna, beidh tú i gcónaí ag iarraidh a fháil amach faoi na puntaí deiridh a úsáid tú ar aon nós, seachnóidh tú an iomarcaachta intiomsaithe agus spleáchas, agus - bunaithe ar ár dtaithí - déanfaidh tú é níos tapúla freisin.

1. Cuntas a chruthú

Tabhair cuairt ar [clárú legalesign] (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 thógála de Legalesign. Tarlaíonn próiseáil doiciméad go léir i bhfoireann. Ní mór duit tagairt a dhéanamh do do fhoireann i bhformhór na nglaonna API.

eolas

Is rud céanna é 'foireann' nó 'grúpa'. San aip ghréasáin labhraímid faoi 'fhoirne', ach sa scéim API is grúpa é.

Socruithe API

Téigh chuig an Painéal API. Gine an dintiúr API sa chuid Eochair API.

Tóg nóiméad le haghaidh athbhreithniú ar an Tairseach Forbróra.

Sandbox

Sa Rannán Timpeallachta, taispeánann foláireamh an bhfuil tú i mód sábaide nó táirgthe.

Sainmhíníonn an sábaid cá bhféadfaidh tú do dhoiciméid a sheoladh. Feicfidh tú foirm le suas le 5 r-phost ceadaithe a chur leis - cuir cúpla ceann anois.

Nuair a bheidh do chomhtháthú réidh: aistrigh go mód táirgthe.

leide

Cruthaigh foireann dhara. Bain úsáid as do chéad fhoireann don fhorbairt agus foireann(í) eile don táirgeadh. Inis don tacaíocht ainm do fhoireann forbartha chun í a eisiamh ón bhilleáil.

Eochair API

Sa Rannán Eochair API feicfidh tú sonraí do eochair API. Taispeántar go amháin an eochair féin duit nuair a chruthaíonn tú ceann.

Tá samplaí cut and paste sa rannán Treoirtóireachta Thapa chun do eochair a thástáil.

Scáileán Rannán Eochair API

Webhooks & Logálacha

Cuireann webhooks leis (do lucht éisteachta do imeachtaí Legalesign), agus athbhreithnigh do logálacha.

Scáileán Rannán 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 n-oibríonn na dintiúirí. Athraigh username agus luachanna rúnda sa chóid thíos.

Ú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 táblaí thíos.

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

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

Nuair a rithfidh tú an fiosrúchán thuas, feicfidh tú do ghrúpaí fillte i JSON. Rath. 👏

Cuimsíonn na sonraí freagartha an 'uris acmhainne' do do ghrúpa agus tá sé cosúil le /api/v1/group/:groupId/. Déan nóta de seo, beidh tú ag teastáil uaidh do chuid is mó glaonna API.

leide

Beidh an uri acmhainne i gcónaí formáidithe ar an mbealach céanna. Do PDF bheadh sé '/api/v1/templatepdf/:pdfId/', do dhoiciméad seolta beidh sé '/api/v1/document/:documentId/'. Tabhair faoi deara go críochnaíonn gach URI le sliotán. Tá sé seo fíor freisin do na URLanna do do ghlaonna API, críochnaigh iad i gcónaí le sliotán.

Má theip ar an iarratas GET ansin seiceáil:

  • go bhfuil do ApiKey formáidithe i gceart (tosaíonn le 'ApiKey'),
  • go bhfuil ceannlíne Content-Type agat don application/json, agus
  • go críochnaíonn do URL le sliotán.

Féach freisin fadhbanna a réiteach.

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

Chun tús a chur, uaslódálfaimid doiciméad tríd an aip ghréasáin agus seolfaimid é sin tríd an API. Clúdóimid conas doiciméad a uaslódáil tríd an API níos déanaí.

Téigh chuig an aip ghréasáin agus uaslódáil do dhoiciméad. Cuir ról sínitheora amháin leis agus tarraing réimse sínithe. Léireoidh leathanach an eagarthóra an bhfuil an doiciméad 'bailí' (d’fhéadfadh sampla de 'neamhbhailí' a bheith má chuir tú ról sínitheora leis gan réimse sínithe gaolmhar).

Sa eagarthóir foirme, cóipeáil an ID fada alfanumerach ón URL, díchódáil base64 é agus seachain na chéad 3 litreacha (ba chóir go mbeadh siad 'tpl'). Is UUID é an chuid fágtha a bhfuil de do ID.

I dtéarmaí REST API is é an uri acmhainne don doiciméad seo ná /api/v1/templatepdf/UUID/.

Foghlaim níos mó faoin bhféidearthacht web agus API.

Is é ár dtéarmaíocht gur 'teimpléid' é doiciméad uaslódáilte agus nuair a sheolann tú ceann cruthaíonn tú 'doiciméad'.

leide

Má theastaíonn uait teimpléid a chartlannú nuair a sheoltar an doiciméad socraigh 'archive_upon_send' mar thoradh san iarratas uaslódála. Má theastaíonn uait nach bhfeicfear an teimpléad riamh agus é a scriosadh tar éis a sheoladh tabhair an teideal '[deleted]' dó - glacfaidh ár gcórais glantacháin é agus scriosfaidh siad é i ndiaidh lá nó dhó. Is féidir leat freisin amanna coinníollacha gearr a shocrú ag leibhéal an ghrúpa - foghlaim níos mó.

4. Seol doiciméad le haghaidh sínithe

Anois seolfaimid é seo tríd an API. Cuimhnigh r-phost a úsáid sna r-phostanna 'ceadaithe' atá agat sa sábaid. Úsáid na táblaí thíos chun an iarratas a fháil sa teanga is fearr leat.

curl -H "Authorization: ApiKey [username]:[secret]" -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 tríd na tréithe uile atá ar fáil. Feicfidh tú go leor cinn a chabhróidh le taobhanna praiticiúla chomhtháthaithe - clibeanna do do thagairtí féin agus IDs (a thagann ar ais chugat sna webhooks), ath-aistriú do shínitheoirí, téacs saincheaptha sa PDF a shocrú, agus níos mó.

Beidh cód stádais 201 ag glao rathúil.

Faigh ID nua an doiciméid sheolta

Is é an chuid thábhachtach den fhreagra an ceannlíne suíomh. Tá do ID nua do dhoiciméad istigh ann.

leide

Úsáid tréithe clibe do dhoiciméid agus cuir d’own tagairtí chun áis a dhéanamh níos éasca ag baint úsáide as do bhunachar sonraí féin.

Beidh an ceannlíne suíomh cosúil le /api/v1/status/:documentId/.

Tugann an URI 'status' sraith ghearr (agus tapaidí chun fiosrú) tréithe doiciméid.

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

eolas

Má theipeann ar iarratas bíonn eolas faoi earráid sa CHOMHRÁ den fhreagra de ghnáth. Mura bhfaigheann tú stádas rath, seiceáil an CHOMHRÁ le haghaidh téacs míniúcháin. Féach freisin fadhbanna a réiteach.

Foghlaim níos mó faoin glao API Seol Doiciméad.

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

Le ID an doiciméid sheolta a fuair tú thuas, déan iarratas íoslódála PDF sa teanga de do rogha:

curl -H "Authorization: ApiKey [username]:[secret]" -o download.pdf -X GET https://eu-api.legalesign.com/api/v1/pdf/:documentId/

Tagairt API Íoslódála PDF.

Tá an PDF dénártha sa chomhlachan freagartha. Cuireann an t-ordú curl '-o' comhlachan an fhreagra go díreach isteach i gcomhad.

Déantar córais REST nó HTTP agus leabharlanna a thógaíonn freagraí HTTP mar chomhaid uaireanta, i dtaobhaíonn sé seo go sábhálfar do ghnáthfhreagra mar chomhad.

leide

Úsáid webhooks chun fógraí gabhálacha a fháil agus ansin an doiciméad a íoslódáil. Féach webhooks.

6. Uaslódáil PDF

Cliceáil anseo chun PDF síntiús téacs-sainithe a íoslódáil samplach, tá níos mó faoi réimsí foirme PDF le tosú.

Don ghlao seo, déan do PDF a thiontú go sreang códaithe base64. Ní dhéantar é seo i gceart laistigh den ghineadóir cód sa doiciméadú. Ina áit sin cóipeáil an pseudochód seo agus d'fhéadfadh do AI é a chur i dteanga do rogha:

$data = (
'group': '/api/v1/group/:groupId/',
'title': 'title of pdf',
'pdf_file': base64encode(open('/path/to/file','rb')),
'process_tags': true
)
$headers = (
'Authorization': 'ApiKey username:secret',
'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 cód stádas '201' agus beidh an ID nua sa cheannlíne 'location' den fhreagra.

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

Beidh do URI acmhainne pdf cosúil le /api/v1/templatepdf/:pdfId/.

Seol an PDF nua

Fill ar an gcód a d’úsáid tú chun do dhoiciméad chéad a sheoladh, agus athraigh an luach templatepdf.

Déanaigh an iarratas arís agus sin é, sheol tú do PDF chun sínithe.

Sula dtosaíonn tú ag códú, áfach, léigh ar aghaidh chun níos mó a fhoghlaim faoi réimsí PDF.

Cad faoi réimsí PDF?

Conas a fhaigheann Legalesign amach cá gcóir don duine síniú a chur ar an PDF, nó na rannáin le athrú ag seoladh? Is é an freagra ná go raibh ár PDF réamhullmhaithe le clibeanna: chuir muid clib téacs Legalesign laistigh den PDF agus shocraíomar 'process_tags' mar fíor san iarratas uaslódála PDF.

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

Is téacs speisialta formáide é clibe téacs chun a chur i PDF. Déanann Legalesign an téacs i do chomhad a pharsáil, ag glacadh na gclib agus ag cur isteach réimsí sínithe agus foirme. Do shínitheoir amháin níl le déanamh ach a chur leis: <<t=signature>>. Aithneoidh Legalesign é agus méadóidh sé an réimse sínithe ann. Foghlaim faoi chlibeanna téacs.

Tá córais foghlama ag clibeanna téacs agus tá trial agus earráid riachtanach. Tá modhanna eile liostaithe thíos, ach bainfidh tú an cumas iomlán idir feidhmchláir Legalesign agus iad. Úsáid an aip ghréasáin chun clibeanna a thástáil. Téigh i dteagmháil le tacaíocht le haghaidh cabhrach agus samplaí.

Seo 4 bealaí eile chun réimsí a shocrú:

1. An leagan is éasca/is tapa. Socraigh do PDF ag baint úsáide as aip ghré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 ligean anuas.

Tarraing agus lig réimse sínithe anuas, ansin tabhair faoi deara an ID códaithe sa URL. Beidh sé cosúil le 'dHBsMTRlZTQ0ZWUtZGE0Ni0xMWVmLTllZmUtMDI5ZGQ0ODkzZGRk'.

Díchódáil ID base64 seo agus feicfidh tú go bhfuil sé UUID le 'tpl' mar réamhchomhartha. Is é an chuid UUID (bain 'tpl') do pdfID. Foghlaim níos mó faoi IDanna Legalesign.

Is é do API URI acmhainne PDF ná - /api/v1/templatepdf/:pdfId/.

Cuir isteach é sin mar thréith 'templatepdf' an glao doiciméad a sheoladh.

eolas

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

2. Úsáid comhordanáidí x/y do réimsí.

Is é an bealach is simplí chun tosú le comhordanáidí x/y ná PDF a shocrú san aip ghréasáin agus ansin fiosrú a dhéanamh tríd an API ar na réimsí sin (FAIGH réimsí PDF - /api/v1/templatepdf/:pdfId/fields/).

Tá an struchtúr JSON a gheobhaidh tú ar ais díreach mar an gcód JSON a theastaíonn uait freisin chun réimsí a chruthú.

Bain úsáid as mar theimpléad. Athraigh aon luachanna agus POST é ar ais chuig an bpointe foirne céanna (ag athrú ID an PDF de réir mar is cuí). Cruthaigh pointe foirne Réimse PDF.

3. Cuir ár leathanach eagarthóireachta PDF isteach. NUA!

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

4. Réimsí Foirme PDF NUA!

Má tá réimsí gnáthfoirme PDF sa doiciméad PDF is féidir le Legalesign iad a aimportáil go huathoibríoch.

Códú sona!

Sa treoir seo fuair tú dintiúirí API, rinne tú fiosrúchán rathúil ar do ghrúpa(ocha), sheol tú doiciméad le haghaidh sínithe ag baint úsáide as HTML agus PDF, agus íoslódáil tú doiciméad sínithe.

Códú sona! Táimid anseo chun cabhrú, téigh i dteagmháil le tacaíocht má tá aon chabhair uait.

leide

Maith thú, shroich tú deireadh - go raibh maith agat as an léamh. Seo ár gceist dheireanach, agus agus leid, bunaithe ar blianta taithí forbróirí ag comhtháthú leis an API seo, ná cuir am amú gan triail a bhaint as na tréithe uile atá ar fáil ar an bpointe foirne cruthú doiciméad (agus cliceáil tríd chun a fheiceáil cad atá istigh i 'shínitheoirí', 'pdftext' agus 'signertext') - is é an glao is tábhachtaí i do chomhtháthú é. Cruthaigh doiciméad sínithe.

Céimeanna gcuí eile: