Dilysu API

Proses ddilysu

Mae'r API hwn yn defnyddio dilysiad Manylion Cleient OAuth2 a ddarperir gan AWS .

Mae'r dull hwn wedi'i gynllunio ar gyfer cyfathrebu rhwng gweinyddwyr , lle nad oes unrhyw ddefnyddiwr terfynol yn gysylltiedig yn uniongyrchol. Yn lle hynny, mae'r rhaglen cleient yn dilysu ei hun gan ddefnyddio ID Cleient a Chyfrinach Cleient .

1. Cael Cymwysterau Cleient

Byddwch yn cael eich darparu â:

• ID Cleient
• Cyfrinach y Cleient

Cynhyrchir y gwerthoedd hyn gan Involve a byddant yn adnabod ac yn diogelu eich cais yn unigryw.

2. Gofyn am Docyn Mynediad

Anfonwch POST   cais i derfynbwynt tocyn SQOD:

POST https://auth.app.sqod.co.uk/oauth2/token
Content-Type: application/x-www-form-urlencoded
Authorization: Basic <base64(client_id:client_secret)>

Gan gynnwys corff y cais canlynol:

math_grant=cymwysterau_cleient

3. Derbyn Tocyn Mynediad

Mae ymateb llwyddiannus yn edrych fel hyn:

{
  "access_token": "eyJraWQiOiJhb...",
  "expires_in": 3600,
  "token_type": "Bearer"
}

• tocyn_mynediad   – Y tocyn a ddefnyddir i awdurdodi ceisiadau API
• yn dod i ben_mewn   – Oes y tocyn mewn eiliadau (3600 = 1 awr)
• math_tocyn   – Bob amser "Cludwr"  

4. Ffoniwch yr API gyda'r Tocyn

Wrth anfon cais bydd angen i chi gynnwys y tocyn yn y Awdurdodiad   pennawd wrth alw'r API:

Awdurdodiad: Cludwr eyJraWQiOiJhb...

Enghraifft:

CAEL https://api.yourcompany.com/v1/resource Awdurdodiad: Cludwr eyJraWQiOiJhb...