Porth Datblygwr
Mae Porth Datblygwr Legalesign yn lle i chi reoli eich mynediad API a goruchwylio eich sefydliad.
Defnyddiwch ef i greu ac analluogi allweddi API, copïo'r nodwyr sydd eu hangen ar eich integreiddiad, rheoli diweddpwyntiau webhook, adolygu dosbarthiadau webhook diweddar, ac archwilio defnydd API ar gyfer eich sefydliad.
Mae’r porth yn disodli’r bwrdd gwaith API hŷn ar gyfer llifiau gwaith rheoli allweddi API newydd. Mae allweddi REST API treftadaeth presennol yn parhau i weithio ar gyfer integreiddiadau presennol, ond dylai integreiddiadau newydd ddefnyddio’r porth a’r fformat allwedd API newydd.
Mynediad
Ewch i developer.legalesign.com. Mewngofnodwch gyda’ch cyfrif Legalesign. Efallai y byddwch yn mewngofnodi’n awtomatig os oes sesiwn weithredol gennych ar y gwe-app.
Mae’n rhaid i’ch cyfrif gael ei gymeradwyo ar gyfer datblygu API. Os yw'r porth yn dweud nad yw rheoli allweddi API wedi’i alluogi ar gyfer eich defnyddiwr, creu tocyn cymorth a gofyn i gadarnhau mynediad API.
Allweddi API
Mae adran Allweddi API yn eich galluogi i greu ac analluogi allweddi API ar gyfer sefydliad.
Pan fyddwch yn creu allwedd, dewiswch:
- Enw allwedd, fel arfer yr integreiddiad neu’r amgylchedd fydd yn ei ddefnyddio.
- Yr rhyngwyneb API: REST, GraphQL, neu'r ddau.
- Cyfnod dod i ben i ddewis.
Dangosir allwedd API plaen testun unwaith, ar unwaith ar ôl creu. Copïwch ef cyn gadael y dudalen oherwydd ni ellir ei ddangos eto.
Mae allweddi newydd yn defnyddio fformat allwedd API menter ac yn cael eu hanfon fel tocyn cludwr:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Dangosir allweddi REST treftadaeth yn wahaniad pan fyddant yn bodoli. Fe’u cefnogir ar gyfer integreiddiadau REST presennol yn unig. Symudwch integreiddiadau newydd i'r allweddi API newydd a diddymwch allweddi treftadaeth pan na fyddant yn cael eu defnyddio mwyach.
Amgylchedd
Mae adran Amgylchedd yn dangos y nodwyr sefydliad a thîm sydd ar gael i’ch cyfrif.
Defnyddiwch yr adran hon pan fo angen cyd-destun sefydliad neu dîm ar gais API. Yn enwedig, dylai ceisiadau API REST sydd yn gweithredu o fewn sefydliad gynnwys y pennawd sefydliad:
X-Organisation: <organisation-id>
Mae’r porth yn dangos y nodwyr GraphQL a REST ochr yn ochr lle maent i'r ddau ar gael.
Os yw’ch defnyddiwr API REST mewn modd sandbox, bydd adran Amgylchedd hefyd yn dangos cyfeiriadau e-bost derbynnydd sandbox a gymeradwywyd. Mae modd sandbox yn cyfyngu anfon dogfennau REST i’r cyfeiriadau hynny'n unig.
Webhooks
Mae adran Webhooks yn eich galluogi i greu, golygu, analluogi, ac dileu diweddpwyntiau webhook.
Ar gyfer pob webhook, dewiswch:
- URL y diweddpwynt.
- Math o ddigwyddiad.
- Cwmpas y grŵp, neu bob grŵp.
- A yw’r webhook wedi’i alluogi ai peidio.
Mae’r porth hefyd yn dangos ymdrechion dosbarthu webhook diweddar. Defnyddiwch y golwg log i archwilio llwythoedd digwyddiadau, statws dosbarthu, a methiannau diweddar.
I hwyluso datblygiad webhook, gallwch hefyd wthio digwyddiadau webhook â llaw ar y dudalen hon.
Ar gyfer setup awtomataidd, gellir hefyd rheoli cyfluniad webhook drwy'r API. Gweler y canllaw webhooks am fanylion integreiddio.
Defnydd
Mae adran Defnydd yn crynhoi gweithgaredd API diweddar ar gyfer y sefydliad a ddewiswyd.
Defnyddiwch ef i wirio:
- Cyfanswm cyfaint y ceisiadau.
- Pa allweddi a ddefnyddiwyd.
- Y prif weithrediadau.
- Nifer y ceisiadau a gymeradwywyd a’u gwnaethpwyd yn anghymeradwy.
- Gweithgaredd cais dros amser.
Dyma’r lle cyntaf i wirio ar ôl creu allwedd a gwneud cais prawf. Mae’n helpu i gadarnhau bod yr allwedd yn cael ei defnyddio a ph’un ai cynigir ceisiadau neu’u gwrthodir.
Gweinyddwr Sefydliad
Gall gweinyddwyr sefydliad weld golwg rheoli ehangach ar gyfer eu sefydliad.
Yn dibynnu ar eich hawliau, gall yr adran hon gynnwys:
- Allweddi API ar lefel sefydliad.
- Allweddi gweithredol a ganslwyd.
- Defnydd ar draws allweddi sefydliad.
- Digwyddiadau archwilio allweddi API.
- Webhooks sefydliad.
Defnyddiwch y golwg hon i adolygu mynediad, analluogi allweddi a berir gan ddefnyddwyr sefydliad, ac archwilio newidiadau diweddar yn natblygiad allweddi API.
