Porth Datblygwr
Mae Porth Datblygu Legalesign yn lle lle gallwch reoli eich mynediad API a goruchwylio eich sefydliad.
Defnyddiwch ef i greu ac atal allweddi API, copïo'r dynodwyr sydd eu hangen ar eich integreiddiad, rheoli pwyntiau gwewebhook, adolygu'r cyflwyniadau gwewebhook diweddar, a dadansoddi'r defnydd API ar gyfer eich sefydliad.
Mae'r porth yn disodli'r hen ddesg reoli API ar gyfer llifoedd gwaith rheoli allwedd API newydd. Mae allweddi API REST etifeddol sydd eisoes yn bodoli yn parhau i weithio ar gyfer integreiddiannau presennol, ond dylai integreiddiannau 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 gweinyddiaeth we.
Mae'n rhaid i'ch cyfrif gael ei gymeradwyo ar gyfer datblygu API. Os yw'r porth yn dweud nad yw rheoli allwedd API wedi'i alluogi ar gyfer eich defnyddiwr, creu tocyn cymorth a gofyn am gadarnhad mynediad API.
Allweddi API
Mae adran Allweddi API yn eich galluogi i greu ac atal allweddi API ar gyfer sefydliad.
Pan fyddwch yn creu allwedd, dewiswch:
- Enw allwedd, fel arfer y integreiddiad neu'r amgylchedd a ddefnyddiaf ef.
- Y rhyngwyneb API: REST, GraphQL, neu'r ddau.
- Cyfnod dod i ben dewisol.
Rhoddir allwedd API mewn testun plaen unwaith yn unig, ar unwaith ar ôl ei greu. Copïwch hi cyn gadael y dudalen gan na ellir ei harddangos eto.
Mae allweddi newydd yn defnyddio fformat allwedd API menter ac yn cael eu hanfon fel tocyn bearer:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Mae allweddi REST etifeddol yn cael eu dangos ar wahân pan fo'n bodoli. Maent yn cael eu cefnogi ar gyfer integreiddiannau REST presennol yn unig. Symudwch integreiddiannau newydd i'r allweddi API newydd a chadwch allweddi etifeddol yn cael eu havdalu pan na ddefnyddir hwy mwyach.
Amgylchedd
Mae adran Amgylchedd yn dangos dynodwyr y sefydliad a'r tîm sydd ar gael i'ch cyfrif.
Defnyddiwch yr adran hon pan fydd cais API angen cyd-destun sefydliad neu dîm. Yn enwedig, dylai ceisiadau API REST sy'n gweithredu o fewn sefydliad gynnwys y pennawd sefydliad:
X-Organisation: <organisation-id>
Mae'r porth yn dangos y dynodwyr GraphQL a REST ochr yn ochr lle mae'r ddau ar gael.
Os yw eich defnyddiwr API REST yn y modd sandbocs, mae adran Amgylchedd yn dangos eich terfyn cyfnod cyfredol (100 o alwadau y awr).
Webhooks
Mae adran Webhooks yn eich galluogi i greu, golygu, analluogi, a dileu pwyntiau gwewebhook.
Ar gyfer pob gwewebhook, dewiswch:
- URL y pwynt.
- Math y digwyddiad.
- Cwmpas y grŵp, neu'r holl grwpiau.
- Pa un ai yw'r gwewebhook wedi'i alluogi.
Mae'r porth hefyd yn dangos y ymdrechion cyflwyno gwewebhook diweddar. Defnyddiwch y golygfa log i archwilio rhestrau digwyddiadau, statws cyflwyno, a methiannau diweddar.
I hwyluso datblygu gwewebhook, gallwch hefyd wthio digwyddiadau gwewebhook yn llaw ar y dudalen hon.
Ar gyfer sefydlu awtomataidd, gellir hefyd rheoli ffurfweddiad gwewebhook trwy'r API. Gweler y canllaw gwewebhook ar gyfer manylion integreiddio.
Defnydd
Mae adran Defnydd yn crynhoi gweithgarwch API diweddar ar gyfer y sefydliad a ddewiswyd.
Defnyddiwch ef i wirio:
- Cyfanswm cyfaint y cais.
- Pa allweddi a ddefnyddiwyd.
- Y gweithrediadau mwyaf poblogaidd.
- Niferoedd cais a ganiateir a rhai gwrthodwyd.
- Gweithgarwch cais dros amser.
Dyma'r lle cyntaf i'w wirio ar ôl creu allwedd a gwneud cais prawf. Mae'n helpu i gadarnhau bod yr allwedd yn cael ei defnyddio a ph'un a yw ceisiadau yn cael eu derbyn neu eu gwrthod.
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 y sefydliad.
- Allweddi gweithredol ac allweddion wedi'u havdalu.
- Defnydd ar draws allweddi sefydliad.
- Digwyddiadau archwilio allwedd API.
- Webhooks y sefydliad.
Defnyddiwch y golwg hon i adolygu mynediad, atal allweddi sydd yng nghyfrif defnyddwyr y sefydliad, a gwirio newidiadau diweddar i gyfnod bywyd allwyd API.
