Pàrlamaid Luchd-leasachaidh
Port-adhair Leasaiche Legalesign Is e seo far am faod thu do chothroman API a riaghladh agus sùil a chumail air do bhuidheann.
Cleachd e airson iuchraichean API a chruthachadh agus a chuir dheth, na h-ainmean-aithne a dh'fheumas do cheangal a lethbhreacadh, puingean crìochnachaidh webhook a riaghladh, lèirmheas a dhèanamh air lìbhrigeadh webhook o chionn ghoirid, agus cleachdadh API do bhuidheann a sgrùdadh.
Tha am port-adhair a’ toirt àite dha seann dashbord API airson sruth-obrach riaghlaidh iuchraichean API ùra. Tha iuchraichean REST API seann-fhasanta a tha ann fhathast ag obair airson ceanglaichean a tha ann mu thràth, ach bu chòir do cheanglaichean ùra an port-adhair agus an cruth iuchra API ùr a chleachdadh.
Faighinn gu Fuirich
Rach gu developer.legalesign.com. Clog a-steach leis an chunntas Legalesign agad. Dh’fhaodadh tu logadh a-steach gu fèin-obrachail ma tha seisean gnìomhach agad air an iarrtas-lìn.
Feumaidh do chunntas a bhith air aontachadh airson leasachadh API. Ma tha am port-adhair ag ràdh nach eil riaghlaidh iuchraichean API air a ghnìomhachadh airson do chleachdaiche, cruthaich ticéad taic agus iarr dearbhadh air faighinn gu API.
Iuchraichean API
Tha an earrann Iuchraichean API gad leigeil leat iuchraichean API a chruthachadh agus a chuir dheth airson buidheann.
Nuair a chruthaicheas tu iuchair, tagh:
- Ainm iuchair, mar as trice an ceangal no an àrainneachd a bhios ga chleachdadh.
- Am eadar-aghaidh API: REST, GraphQL, no an dà chuid.
- Àm crìochnachaidh roghnach.
Thathar a’ sealltainn iuchair API anns an teacsa soilleir aon turas, sa bhad an dèidh a chruthachadh. Lethbhreacaich e mus fhàg thu an duilleag oir chan urrainn a shealltainn a-rithist.
Bidh iuchraichean ùra a’ cleachdadh cruth iuchair API iomairt agus thèid an cur mar thòcan beàrna:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Tha iuchraichean REST seann-fhasanta air an sealltainn gu sònraichte nuair a tha iad ann. Tha taic aca airson ceanglaichean REST a th’ ann mu thràth a-mhàin. Gluais ceanglaichean ùra gu iuchraichean API ùra agus cuir dheth iuchraichean seann-fhasanta nuair nach eilear gan cleachdadh tuilleadh.
Àrainneachd
Tha earrann Àrainneachd a’ sealltainn na h-ainmean-aithne buidhne agus sgioba a tha ri fhaighinn don chunntas agad.
Cleachd an earrann seo nuair a dh’fheumas iarrtas API co-theacsa buidheann no sgioba. Gu sònraichte, bu chòir iarrtasan REST API a tha ag obair taobh a-staigh buidheann a bhith a’ gabhail a-steach am bàr ceann-oideachaidh buidheann:
X-Organisation: <organisation-id>
Tha am port-adhair a’ sealltainn na h-ainmean-aithne GraphQL agus REST thaobh ri taobh far a bheil an dà chuid rim faighinn.
Ma tha do chleachdaiche REST API ann an modh sandbox, tha earrann Àrainneachd a’ sealltainn cuideachd na seòlaidhean puist-d neach-fhreagairt sandbox a tha air an ceadachadh. Tha modh sandbox a’ cuingealachadh cur sgrìobhainnean REST gu na seòlaidhean sin a-mhàin.
Webhooks
Tha an earrann Webhooks gad chumas comasach air puingean crìochnachaidh webhook a chruthachadh, a dheasachadh, a chuir dheth, agus a dhubhadh às.
Airson gach webhook, tagh:
- URL a’ phuinge crìochnachaidh.
- Seòrsa tachartais.
- Raon na buidhne, no a h-uile buidheann.
- Am bheil an webhook gnìomhach.
Tha am port-adhair cuideachd a’ sealltainn oidhirpean lìbhrigidh webhook o chionn ghoirid. Cleachd an sealladh log gus am pailt tachartais, inbhe lìbhrigidh, agus fàilligidhean 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 fiosrachadh air ceangal.
Cleachdadh
Tha an earrann Cleachdadh a’ geàrr-chunntas gnìomhachd API o chionn ghoirid airson a’ bhuidheann a chaidh a thaghadh.
Cleachd e gus sùil a chumail air:
- Tomhas iomlan iarrtasan.
- Dè na iuchraichean a chaidh a chleachdadh.
- Prìomh ghnìomhan.
- Cunntasan iarrtas ceadaichte agus diùltadh.
- Gnìomhachd iarrtasan thar ùine.
Is e seo an àite as fheàrr airson sùil a thoirt às dèidh iuchair a chruthachadh agus iarrtas deuchainn a dhèanamh. Bidh e a’ cuideachadh gus dearbhadh gu bheil an iuchair ga cleachdadh agus a bheil iarrtasan ga gabhail no ga diùltadh.
Stiùiriche Buidheann
Faodaidh stiùirichean buidhne sealladh riaghlaidh nas fharsainge fhaicinn airson an buidhne fhèin.
A dh’fhaoidte, a rèir nan ceadan agad, gum bi an earrann seo a’ toirt a-steach:
- Iuchraichean API aig ìre buidhne.
- Iuchraichean gnìomhach agus air an cur dheth.
- Cleachdadh thar iuchraichean buidhne.
- Tachartasan sgrùdaidh iuchraichean API.
- Webhooks a’ bhuidhne.
Cleachd am sealladh seo airson sùil a thoirt air faighinn, iuchraichean a chuir dheth air an deagh sheilbh aig luchd-cleachdaidh a' bhuidhne, agus atharrachaidhean o chionn ghoirid ann an beatha iuchraichean API a sgrùdadh.
