Tairseach Forbróra
Is é Ionad Forbróra Legalesign an áit ar féidir leat rochtain do API a bhainistiú agus do eagraíocht a mhaoirsiú.
Úsáid é chun eochracha API a chruthú agus a chealú, na haitheantóirí atá ag teastáil ó do chomhtháthú a chóipeáil, deireadhphointí webhook a bhainistiú, seachadtaí déanaí webhook a athbhreithniú, agus úsáide API do do eagraíocht a iniúchadh.
Cuireann an pobal ionchasach an painéal agus an sean-dashbord API in ionad do shruthanna oibre nua bainistíochta eochracha API. Leanann eochracha REST API seanlaigh ann don chomhtháthú atá ann cheana féin, ach ba chóir do chomhtháthú nua an pobal ionchasach agus an fhormáid nua eochair API a úsáid.
Rochtain
Téigh go developer.legalesign.com. Sín isteach le do chuntas Legalesign. Féadfaidh tú logáil isteach go huathoibríoch má tá seisiún gníomhach agat ar an aip gréasáin.
Ní mór do do chuntas a bheith ceadaithe do fhorbairt API. Má deir an pobal ionchasach nach bhfuil bainistíocht eochair API cumasaithe don úsáideoir agat, cruthaigh ticéad tacaíochta agus iarr ar rochtain API a dheimhniú.
Eochracha API
Ligfidh an chuid Eochracha API duit eochracha API a chruthú agus a chealú d’eagraíocht.
Nuair a chruthaíonn tú eochair, roghnaigh:
- Ainm eochair, de ghnáth don chomhtháthú nó don timpeallacht a úsáidfidh é.
- An comhéadan API: REST, GraphQL, nó an dá rud.
- Tréimhse éaga roghnach.
Taispeántar an eochair API i bhfíorchomhad uair amháin, láithreach tar éis an chruthaithe. Cóipeáil é sula bhfágann tú an leathanach mar ní féidir é a thaispeáint arís.
Úsáideann eochracha nua an fhormáid eochair API fiontair agus seoltar iad mar thicéad bearer:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Taispeántar eochracha REST seanlaigh ar leithligh nuair atá siad ann. Tá siad tacaíochta do chomhtháthú REST atá ann cheana féin amháin. Bog comhtháthú nua go dtí na heochracha nua API agus cealaigh na heochracha seanlaigh nuair nach n-úsáidtear iad níos mó.
Timpeallacht
Taispeánann an chuid Timpeallacht na haithintí eagraíochta agus foirne atá ar fáil do do chuntas.
Úsáid an chuid seo nuair is gá comhthéacs eagraíochta nó foirne i gceist le hiarratas API. Go háirithe, ba cheart d’iarratais REST API atá ag gníomhú laistigh d’eagraíocht an ceannlínte eagraíochta a áireamh:
X-Organisation: <organisation-id>
Taispeánann an pobal ionchasach na haithintí GraphQL agus REST taobh le taobh nuair atá an dá cheann ar fáil.
Má tá do úsáideoir REST API i mód sandbox, taispeánann an chuid Timpeallacht do theorainn scaoilte reatha (100 glao an uair an chloig).
Webhooks
Ligfidh an chuid Webhooks duit deireadhphointí webhook a chruthú, a chur in eagar, a dhíchumasú, agus a scriosadh.
Do gach webhook, roghnaigh:
- URL an deireadhphointe.
- Cineál an eachtra.
- Réimse na grúpa, nó na ngrúpaí go léir.
- An bhfuil an webhook cumasaithe nó nach bhfuil.
Taispeánann an pobal ionchasach freisin iarrachtaí seachadta webhook le déanaí. Úsáid an amharc loga chun iniúchadh a dhéanamh ar phacáistí eachtraí, stádas seachadta, agus teipí le déanaí.
Chun forbairt webhook a éascú, is féidir leat eachtraí webhook a bhrú de láimh ar an leathanach seo freisin.
Le haghaidh socrú uathoibrithe, is féidir cumraíocht webhook a bhainistiú tríd an API freisin. Féach an treoir webhooks le haghaidh sonraí comhtháthaithe.
Úsáid
Líomhnaíonn an chuid Úsáide gníomhaíochtaí API le déanaí don eagraíocht roghnaithe.
Úsáid é chun seiceáil:
- Hiomlán an toirt iarratais.
- Cé na heochracha a úsáideadh.
- Na hoibríochtaí is mó.
- Líon na n-iarratas ceadaithe agus diúltaithe.
- Gníomhaíocht iarratais thar am.
Is é seo an chéad áit le seiceáil tar éis eochair a chruthú agus iarratas tástála a dhéanamh. Cabhraíonn sé chun dearbhú a dhéanamh go bhfuil an eochair á húsáid agus an bhfuil iarratais á nglacadh nó á n-diúltú.
Riarthóir Eagraíochta
Féachann riarthóirí eagraíochta ar léargas bainistíochta níos leithne dá n-eagraíocht.
Ag brath ar do cheadanna, d’fhéadfadh an chuid seo a bheith ina bhfuil:
- Eochracha API ar leibhéal eagraíochta.
- Eochracha gníomhacha agus cealaithe.
- Úsáid na n-eochracha eagraíochta go léir.
- Imeachtaí iniúchta eochair API.
- Webhooks eagraíochta.
Úsáid an amharc seo chun rochtain athbhreithniú, eochracha a chealú atá ag baint le húsáideoirí eagraíochta, agus athruithe sa saolré eochair API a iniúchadh.
