Port-uillean Leasaiche
Portal Luchd-leasachaidh Legalesign is àite far am faod thu ruigsinneachd API a riaghladh agus do bhuidheann a choimhead.
Cleachd e gus iuchraichean API a chruthachadh agus a thoirt air ais, na h-aitheantaran a dh’fheumas do cheangal a chur an cèill, puingean-eòlas webhook a riaghladh, sùil a thoirt air lìbhrigeadh webhookan o chionn ghoirid, agus cleachdadh API airson do bhuidheann a sgrùdadh.
Tha am portal a’ toirt àite do dashboòrd API nas sine airson sruth-obrach riaghlaidh iuchraichean API ùr. Tha iuchraichean REST API seann-fhasanta a tha ann mar-thà fhathast ag obair airson ceanglaichean seann-fhasanta, ach bu chòir do cheanglaichean ùra an portal agus an cruth ùr iuchrach API a chleachdadh.
Ruigsinneachd
Rach gu developer.legalesign.com. Cuir a-steach le cunntas Legalesign agad. Dh’fhaodadh tu logadh a-steach gu fèin-obrachail ma tha seisean gnìomhach agad anns an app lìn.
Feumaidh do chunntas a bhith air aontachadh airson leasachadh API. Ma tha am portal ag ràdh nach eil riaghladh iuchraichean API air a ghnìomhachadh airson do chleachdaiche, cruthaich tiocaid taic agus iarr gun tèid ruigsinneachd API a dhearbhadh.
Iuchraichean API
Leigidh an roinn Iuchraichean API leat iuchraichean API a chruthachadh agus a thoirt air ais airson buidheann.
Nuair a chruthaicheas tu iuchair, tagh:
- Ainm iuchrach, mar as trice an ceangal no an àrainneachd a bhios ga chleachdadh.
- An eadar-aghaidh API: REST, GraphQL, no an dà chuid.
- Riaghladh aois neo-obrachail.
Thèid an iuchair API ann an teacs soilleir a shealltainn aon uair, sa bhad às dèidh a chruthachadh. Dùblaich e mus fàg thu an duilleag oir chan urrainnear a shealltainn a-rithist.
Tha iuchraichean ùra a’ cleachdadh cruth iuchrach API iomairt agus thèid an cur mar token bearra:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Thèid iuchraichean seann-fhasanta REST a shealltainn gu sònraichte nuair a tha iad ann. Tha taic aca airson ceanglaichean REST seann-fhasanta a-mhàin. Gluais ceanglaichean ùra chun iuchrach API ùr agus thoir air ais iuchraichean seann-fhasanta nuair nach eilear gan cleachdadh tuilleadh.
Àrainneachd
Tha an roinn Àrainneachd a’ sealltainn na h-aitheantaran buidhne agus sgioba rim faighinn don chunntas agad.
Cleachd an roinn seo nuair a tha iarrtas API a dhìth co-theacsa buidhne no sgioba. Gu sònraichte, bu chòir iarrtasan REST API a bhios ag obrachadh taobh a-staigh buidhne a bhith a’ toirt a-steach am ceann-sgrìobhaidh buidhne:
X-Organisation: <organisation-id>
Tha am portal a’ sealltainn a’ chàrn GraphQL agus REST ri taobh a chèile far am faighear an dà chuid.
Ma tha an cleachdaiche REST API agad ann am modh ghainmhich, tha an roinn Àrainneachd a’ sealltainn an cuingealachadh throttling làithreach agad (100 gairmean sa uair).
Webhooks
Leigidh an roinn Webhooks leat puingean-eòlach webhook a chruthachadh, a dheasachadh, a chuir dheth, agus a sgrios.
Airson gach webhook, tagh:
- An URL puing-eòlach.
- Seòrsa tachartais.
- Raon a’ bhuidheann, no na buidhnean gu lèir.
- A bheil am webhook gnìomhach no nach eil.
Tha am portal cuideachd a’ toirt sealladh air oidhirpean lìbhrigidh webhook o chionn ghoirid. Cleachd sealladh an loga gus payloadan tachartais, inbhe lìbhrigidh, agus fàiligeadh o chionn ghoirid a sgrùdadh.
Gus leasachadh webhook a dhèanamh nas fhasa, faodaidh tu tachartasan webhook a phutadh gu làimhe air an duilleag seo cuideachd.
Airson rèiteachadh fèin-ghluasadach, faodar rèiteachadh webhook a riaghladh cuideachd tro API. Faic an stiùireadh webhooks airson mion-fhiosrachadh ceangail.
Cleachdadh
Tha an roinn Cleachdadh a’ toirt geàrr-chunntas air gnìomhan API o chionn ghoirid airson a’ bhuidheann a thagh thu.
Cleachd e gus sgrùdadh a dhèanamh air:
- Sònrachas iomlan iarrtais.
- Dè an iuchair a chaidh a chleachdadh.
- Prìomh obrachaidhean.
- Cunntasan iarrtas ùghdarraichte agus dhiùltadh.
- Gnìomhachd iarrtas thar ùine.
Is e seo an àite as fheàrr a sgrùdadh às dèidh iuchair a chruthachadh agus iarrtas deuchainn a dhèanamh. Cuidichidh e thu gus dearbhadh a bheil an iuchair gan cleachdadh agus a bheil iarrtasan air am gabhail ris no a dhiùltadh.
Rianaire Buidheann
Faodaidh rianairean buidhne sealladh riaghlaidh nas fharsainge fhaicinn airson an buidhne.
A rèir do cheadan, faodaidh an roinn seo gabhail a-steach:
- Iuchraichean API aig ìre buidhne.
- Iuchraichean gnìomhach agus air an toirt air ais.
- Cleachdadh thar iuchraichean buidhne.
- Tachartasan sgrùdaidh iuchraichean API.
- Webhooks buidheann.
Cleachd an sealladh seo gus ruigsinneachd a sgrùdadh, iuchraichean a th’ aig luchd-cleachdaidh buidhne a thoirt air ais, agus atharrachaidhean beatha iuchraichean API o chionn ghoirid a sgrùdadh.
