AuthenticationClient

Բովանդակություն

• Ներածություն
• Կոնստրուկտոր
• Մեթոդներ
  • AuthenticateWithCertificateAsync
  • AuthenticateWithSecretAsync

Ներածություն

8X սերվիս լոգին լինելու համար անհրաժեշտ է նախապես սահմանել մուտք գործող կլիենտ ծրագիր։

Այն անհրաժեշտ է ստեղծել 4X կամ 8X համակարգի UI-ից “API Client-ներ” դիտելու ձևից “Ավելացնել” կոնտեքստային ֆունկցիայով՝ նշելով կլիենտի վավերականացման եղանակը (սերտիֆիկատով կամ բանալիով) և նկարագրելով Json ֆորմատի Manifest ֆայլ, որը սահմանում է կլիենտ ծրագրի իրավասությունները և սահմանափակումները (որ օգտագործողները կարող են մուտք գործել համակարգ, որ տվյալների աղբյուրներին, փաստաթղթերին, DPR-ներին կարող են դիմել ու որ API կանչերը կատարել)։

Իսկ կլիենտի ծրագրի միջոցով մուտք գործող օգտագործողի նույնականացումը կատարվում է այս դասի մեթոդների միջոցով։

Կոնստրուկտոր

public class AuthenticationClient(string baseUrl, HttpClient httpClient, ILogger logger)

Պարամետրեր

• baseUrl - Սերվիսի հասցեն։
• httpClient - HttpClient դասի օբյեկտ, որը նախատեսված է AuthenticationClient դասի մեթոդների միջոցով նույնականացման ընթացքում դեպի Web API հարցումներ կատարելու համար։
• logger - ILogger դասի օբյեկտ, որը նախատեսված է AuthenticationClient դասի մեթոդների միջոցով նույնականացման ընթացքում առաջացած սխալների լոգավորման համար։

Մեթոդներ

AuthenticateWithCertificateAsync

public Task<CertificateAuthenticateResponse> AuthenticateWithCertificateAsync(CertificateAuthenticateRequest certificateAuthenticateRequest, CancellationToken cancellationToken = default)

Նույնականացնում է սերտիֆիկատով նույնականացված կլիենտ ծրագրի օգտագործողի մուտքը համակարգ։ Նույնականացման հաջողման դեպքում վերադարձնում է օգտագործողի տվյալները և տոկեն՝ դեպի սերվիս հարցումներ կատարելու համար, հակառակ դեպքում վերադարձնում է սխալ։

Պարամետրեր

• certificateAuthenticateRequest - Նույնականացման ենթակա օգտագործողի և այն ծրագրի տվյալները, որով օգտագործողը մուտք է գործում համակարգ։
• cancellationToken - Ընդհատման տոկեն։

AuthenticateWithSecretAsync

public Task<AuthenticateResponse> AuthenticateWithSecretAsync(string username, short apiClientId, string secret, CancellationToken cancellationToken = default)

Նույնականացնում է բանալիով նույնականացված կլիենտ ծրագրի օգտագործողի մուտքը համակարգ։ Նույնականացման հաջողման դեպքում վերադարձնում է օգտագործողի տվյալները և տոկեն՝ դեպի սերվիս հարցումներ կատարելու համար, հակառակ դեպքում վերադարձնում է սխալ։

Պարամետրեր

• username - Օգտագործողի մուտքանունը (ներքին անունը)։
• apiClientId - Կլիենտ ծրագրի id-ն, որով մուտք է գործում օգտագործողը։
• secret - Կլիենտ ծրագրի բանալին։
• cancellationToken - Ընդհատման տոկեն։

Օրինակ

Տե՛ս օգտագործման օրինակը։