Portáil Forbróra
Is é Ionad Forbróra Legalesign an áit a bhainistíonn tú do rochtain API agus a dhéanann tú maoirseacht ar do eagraíocht.
Úsáid é chun eochracha API a chruthú agus a chealú, na haitheantóirí atá ag teastáil do do chomhtháthú a chóipeáil, deireadhphointí webhook a bhainistiú, dáileacháin le déanaí webhook a athbhreithniú, agus úsáid API do d'eagraíocht a iniúchadh.
Cuireann an t-ionad in áit an painéal API níos sine do shreafaí oibre nua bainistíochta eochracha API. Leanfaidh eochracha API REST seanbhunaithe atá ann cheana ag obair do chomhtháthuithe atá ann cheana, ach ba cheart do chomhtháthuithe nua an t-ionad agus an fhormáid nua eochracha API a úsáid.
Rochtain
Téigh go developer.legalesign.com. Logáil 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.
Caithfidh do chuntas a bheith ceadaithe le haghaidh forbartha API. Má deir an t-ionad nach bhfuil bainistíocht eochracha API gníomhach do do úsáideoir, cruthaigh ticéad tacaíochta agus iarr go ndéanfar do rochtain API a fhíorú.
Eochracha API
Ceadaíonn an chuid Eochracha API duit eochracha API a chruthú agus a chealú do eagraíocht.
Nuair a chruthaíonn tú eochra, roghnaigh:
- Ainm eochrach, de ghnáth an chomhtháthú nó an timpeallacht a úsáidfidh é.
- An comhéadan API: REST, GraphQL, nó an dá cheann.
- Tréimhse éaga roghnach.
Taispeántar an eochra API i gcló fhoirmiúil uair amháin, láithreach tar éis é a chruthú. Cóipeáil é sula bhfágann tú an leathanach toisc nach féidir é a thaispeáint arís.
Úsáideann eochracha nua an fhormáid eochracha API fiontair agus seoltar iad mar thicéad iompróra:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Taispeántar eochracha REST oidhreachta ar leithligh nuair atá siad ann. Tá tacaíocht acu do chomhtháthuithe REST atá ann cheana amháin. Bog comhtháthuithe nua chuig na heochracha API nua agus cealú eochracha oidhreachta nuair nach n-úsáidtear iad níos mó.
Timpeallacht
Taispeánann an chuid Timpeallacht na haitheantóirí eagraíochta agus foirne atá ar fáil do do chuntas.
Úsáid an chuid seo nuair is gá do iarratas API comhthéacs eagraíochta nó foirne. Go háirithe, ba chóir d’iarratais API REST a dhéanann gníomh laistigh d’eagraíocht an ceannlíne eagraíochta a áireamh:
X-Organisation: <organisation-id>
Taispeánann an t-ionad na haitheantóirí GraphQL agus REST taobh le taobh nuair atá an dá cheann ar fáil.
Má tá do úsáideoir API REST i mód sandbox, taispeánann an chuid Timpeallacht seoltaí r-phoist faighteoirí ceadaithe sandbox freisin. Cumasaíonn mód sandbox seoltaí doiciméad REST go na seoltaí sin amháin.
Webhooks
Ceadaíonn an chuid Webhooks duit deireadhphointí webhook a chruthú, a chur in eagar, a dhíchumasú, agus a scriosadh.
Roghnaigh do gach webhook:
- URL an deireadhphointe.
- Cineál an imeachta.
- Raon an ghrúpa, nó gach grúpa.
- An bhfuil an webhook cumasaithe nó nach bhfuil.
Taispeánann an t-ionad freisin iarrachtaí seachadta webhook le déanaí. Úsáid an radharc log chun iniúchadh a dhéanamh ar bharúlacha imeachta, stádas seachadta, agus teipanna deireanacha.
Chun forbartha webhook a éascú, is féidir leat imeachtaí webhook a bhrú de láimh ar an leathanach seo freisin.
Le haghaidh socruithe uathoibrithe, is féidir cumraíocht webhook a bhainistiú freisin tríd an API. Féach ar an treoir webhooks le haghaidh sonraí comhtháthaithe.
Úsáid
Cuireann an chuid Úsáide achoimre ar ghníomhaíocht API le déanaí don eagraíocht roghnaithe.
Úsáid é chun a sheiceáil:
- Imréiteach iomlán iarratas.
- Cé na heochracha a úsáideadh.
- Na hoibríochtaí barr.
- Líon na n-iarratas údaraithe agus diúltaithe.
- Gníomhaíocht iarratais le himeacht ama.
Is é seo an chéad áit le seiceáil tar éis eochra a chruthú agus iarratas tástála a dhéanamh. Cabhraíonn sé le dearbhú go bhfuil an eochra á úsáid agus an bhfuil iarratais á nglacadh nó á ndiúltú.
Riarthóir Eagraíochta
Féadann riarthóirí eagraíochta radharc bainistíochta níos leithne a fheiceáil dá n-eagraíocht.
Ag brath ar do cheadanna, d’fhéadfadh an chuid seo a áireamh:
- Eochracha API ar leibhéal na heagraíochta.
- Eochracha gníomhacha agus cealaithe.
- Úsáid ar fud eochracha na heagraíochta.
- Imeachtaí iniúchta eochracha API.
- Webhooks eagraíochta.
Úsáid an radharc seo chun rochtain a athbhreithniú, eochracha a chealú atá faoi úinéireacht ag úsáideoirí na heagraíochta, agus athruithe déanaí sa saolré eochracha API a iniúchadh.
