Sleamhnú go príomh-ábhar

Webhooks Oidhreachta ar Legalesign

Cad iad webhooks oidhreachta

Is é ár seanchóras webhook iad na webhooks oidhreachta. Más rud é go bhfuil tú ag smaoineamh ar úsáid a bhaint as webhooks den chéad uair, bain úsáid as an gcóras níos nuaí - new webhooks

Leanfaidh muid ar aghaidh ag tacú le webhooks oidhreachta don todhchaí inúsáidte chun comhoiriúnacht siar a chinntiú. Má athraíonn sé sin gheobhaidh tú fógra go leor. Molaimid duit uasghrádú a dhéanamh ar aon nós, tá na webhooks fíor-ama faoi ghníomh do níos mó imeachtaí, tá níos mó eolais úsáideach iontu, is féidir iad a scagadh níos éifeachtaí agus tarlóidh siad níos tapúla.

Cineálacha webhook

Tá dhá chineál webhook oidhreachta ann.

  • Ag [imeacht] (as dáta)
  • Gach imeacht gach 6 nóiméad (as dáta)

Conas webhook a chur leis nó a bhaint

Cur leis nó bain úsáid as an aip gréasáin

Téigh chuig socruithe agus feicfidh tú an painéal webhooks. Tá rialuithe simplí sa fhoirm chun webhooks a chur leis nó a bhaint.

painéal webhooks

contúirteach

Tá do eochair API bunaithe ar do chuntas agus ní ar ghrúpa nó eagraíocht aonair. Tugann sé seo níos mó solúbthachta do do eochair API, ach gheobhaidh do webhooks eolas ó gach cuntas ina bhfuil tú ina riarthóir, dev agus prod araon. Chun webhooks a idirdhealú de réir ghrúpa bain úsáid as an scagaire, nó (an modh seanbhunaithe) cruthaigh úsáideoir riarthóra nua atá ina bhall amháin den nó den na grúpa(í) atá á n-aimsiú, faigh eochair API dóibh, agus bain úsáid as an gcuntas sin do do webhook.

Cur leis nó bain úsáid as an API

Bain úsáid as iarratais GET agus POST simplí thar REST API chun liosta a fháil, cruthú nó scriosadh a dhéanamh ar webhooks.

Chun tuilleadh eolais a fháil féach an doiciméadú: API webhooks

Foirmead webhook ‘Ag ...’

Is webhooks iad seo a spreagtar do imeacht ar leith - sínithe, cruthú, diúltú, nó cuairt theipthe.

Seoltar iad mar iarratais POST chuig do URL.

Tá ainm an doiciméid, cód imeachta, URI an acmhainní, clibeanna agus UUID an doiciméid iontu. Seo an praghaschlár ó ngrok.

Webhook Ag

Foirmead nuashonrú ginearálta / webhook 6 nóiméad

Féachann an glao 6 nóiméad mar seo:

webhook 6 nóiméad

Mar a fheiceann tú is iarratas POST é freisin. Ach an uair seo tá an t-eolas go léir stóráilte sa tréith 'data' POST mar réad JSON.

Seo an réad JSON sin sa mhionsonra:

[
{
"value": "5",
"timestamp": "2022-07-11T07:28:25+00:00",
"resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
"name": "status"
},
{
"value": "10",
"timestamp": "2022-07-11T07:28:26+00:00",
"resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
"name": "status"
},
{
"value": "20",
"timestamp": "2022-07-11T07:28:55+00:00",
"resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
"name": "status"
},
{
"value": "20",
"timestamp": "2022-07-11T07:29:06+00:00",
"resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
"name": "status"
},
{
"value": "30",
"timestamp": "2022-07-11T07:29:06+00:00",
"resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
"name": "status"
},
{
"value": "40",
"timestamp": "2022-07-11T07:29:06+00:00",
"resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
"name": "status"
},
{
"value": "30",
"timestamp": "2022-07-11T07:29:06+00:00",
"resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
"name": "status"
},
{
"value": "100",
"timestamp": "2022-07-11T07:29:09+00:00",
"resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
"name": "status"
}
]

Cad atá ag tarlú anseo? Tá an webhook nuashonrú ginearálta ag tabhairt duit anois gach sonra faoi cad a tharla i síniú doiciméid, agus cathain. Cuimsíonn sé nuashonruithe imeachta do shíntiúsóir agus do dhoiciméad araon.

rabhadh

Beidh tú tar éis a thabhairt faoi deara go n-úsáideann muid na focail ‘faighteoir’ agus ‘síntiúsóir’. Is ionann iad seo. Léiríonn an úsáid a bhaint as faighteoir na róil níos casta atá ar fáil anois i Legalesign agus beidh sé mar ainm nua do ‘síntiúsóir’ agus muid ag forbairt.

Is é scéal sonraí an webhook seo ná gur cruthaíodh an réad síntiúsóra (síntiúsóir 5), seolta (síntiúsóir 10), chríochnaigh an síntiúsóir a pháirc (síntiúsóir 30), agus shínigh sé (síntiúsóir 40), thug an doiciméad faoi deara go raibh a pháirceanna críochnaithe (doiciméad 20), ansin marcáilte mar shínithe (doiciméad 30), agus ansin réidh le híoslódáil (doiciméad 100).

Is cód imeachta speisialta é ‘100’ chun a dhearbhú go bhfuil doiciméad réidh le híoslódáil.

Stádas doiciméad

StádasMíniú
10Seolta
20Páirceanna críochnaithe
30Críochnaithe
40Bainte (roimh síniú)
50Diúltaithe

Stádas síntiúsóra

StádasMíniú
4Neamhsheolta
5Sceidealta le seoladh
10Seolta
15Ríomhphost oscailte
20Cuairt ghníomhach
30Páirceanna críochnaithe
35Páirceanna déanta ach gan na réimsí sínithe
39Fianaise don tsíniú
40Críochnaithe
50Íoslódáilte
60Diúltaithe

Déan dífhabhtú ar webhooks san painéal API

Tá gach webhooks logáilte agus is féidir leat a n-ábhar agus cód stádas http a scrúdú i do phainéal API. Chun tuilleadh a fhoghlaim féach an Taispeántas painéil

Téigh go díreach chuig painéal API.

Déanaigí teagmháil linn

Ba cheart go gclúdódh sin gach rud atá uait faoin webhooks oidhreachtacha.

Má tá aon cheist eile agat le do thoil déan teagmháil - support.legalesign.com.