AuthenticationClient

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

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

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

AuthenticationClient դասը նախատեսված է 8X սերվիսին միացման ժամանակ նույնականացնելու համար։

Հնարավորության դեպքում նախընտրելի է օգտագործել LoginService դասը նույնականացման համար։

8X սերվիսին որևէ ծրագրից միանալու համար անհրաժեշտ է նախապես սահմանել API Client։

Նույնականացումից հետո օգտագործվում է ApiClient ստեղծելու և դրա միջոցով սերվիսին հարցումներ կատարելու համար։

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

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

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

Պարամետրեր

• baseUrl - 8X սերվիսի հասցեն։
• httpClient - HttpClient դասի օբյեկտ, որը նախատեսված է նույնականացման և նույնականացումից հետո Http հարցումներ կատարելու համար է։ Օբյեկտը հարկավոր է բաց պահել քանի դեռ կատարվում են հարցումներ։
• logger - ILogger դասի օբյեկտ, որը օգտագործվում է հարցումների և արդյունքների լոգավորման համար լոգավորման համար։
  Կարող է փոխանցվել null։

Մեթոդներ

AuthenticateWithCertificateAsync

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

Նույնականացնում է օգտագործողի մուտքանունով և գաղտնաբառով, պահանջվում է սերտիֆիկատի առկայություն (API Client)։

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

Պարամետրեր

• certificateAuthenticateRequest - Օգտագործողի և API Client-ի տվյալները։
• cancellationToken - Ընդհատման օբյեկտ։

AuthenticateWithSecretAsync

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

Նույնականացնում է ինտեգրման ծրագրի համար ստեղծված բանալիով (API Client)։

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

Պարամետրեր

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

Օրինակ

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