Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

programatix/smac-client-csharp

Open more actions menu

Repository files navigation

Org.OpenAPITools - the C# library for the SMAC API

SMAC ASP.NET Core Web API

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://smac-poc.mcs-group.com.my/";
            // Configure API key authorization: apiKey
            config.ApiKey.Add("X-SMAC-PLATFORM-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-SMAC-PLATFORM-API-KEY", "Bearer");
            // Configure Bearer token for authorization: bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new BiometricsApi(config);
            var facePhotoRequest = new FacePhotoRequest(); // FacePhotoRequest |  (optional) 

            try
            {
                // Retrieves the facial photo
                FacePhotoResponse result = apiInstance.ApiBiometricsFacePhotoPost(facePhotoRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BiometricsApi.ApiBiometricsFacePhotoPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://smac-poc.mcs-group.com.my/

Class Method HTTP request Description
BiometricsApi ApiBiometricsFacePhotoPost POST /api/Biometrics/facePhoto Retrieves the facial photo
BiometricsApi ApiBiometricsUtilsCropFacePost POST /api/Biometrics/utils/cropFace Crops the face from the given image.
BiometricsApi ApiBiometricsUtilsExtractFacePost POST /api/Biometrics/utils/extractFace Extracts the biometric face template from the given image.
BiometricsApi ApiBiometricsUtilsExtractFingerPost POST /api/Biometrics/utils/extractFinger Extracts the biometric finger template from the given image.
BiometricsApi ApiBiometricsUtilsExtractIrisPost POST /api/Biometrics/utils/extractIris Extracts the biometric iris template from the given image.
BiometricsApi ApiBiometricsUtilsVerifyFacePost POST /api/Biometrics/utils/verifyFace Performs face verification.
BiometricsApi ApiBiometricsUtilsVerifyFingerPost POST /api/Biometrics/utils/verifyFinger Performs finger verification.
BiometricsApi ApiBiometricsUtilsVerifyIrisPost POST /api/Biometrics/utils/verifyIris Performs iris verification.
BiometricsApi ApiBiometricsVerifyFacePost POST /api/Biometrics/verifyFace Performs face verification of the user provided in the request parameters.
BiometricsApi ApiBiometricsVerifyFingerPost POST /api/Biometrics/verifyFinger Performs finger verification of the user provided in the request parameters.
BiometricsApi ApiBiometricsVerifyIrisPost POST /api/Biometrics/verifyIris Performs iris verification of the user provided in the request parameters.
DatasetsApi ApiDatasetsGet GET /api/Datasets Gets the datasets for the current user.
DatasetsApi ApiDatasetsIdDelete DELETE /api/Datasets/{id} Deletes the specified dataset for the current user.
DatasetsApi ApiDatasetsIdGet GET /api/Datasets/{id} Gets the specific dataset for the current user.
DatasetsApi ApiDatasetsIdPut PUT /api/Datasets/{id} Updates the specified dataset for the current user.
DatasetsApi ApiDatasetsPost POST /api/Datasets Creates a new dataset for the current user.
OAuthApi ApiOAuthVerifyTokenPost POST /api/OAuth/verify-token Verifies token issued by SMAC for OAuth purposes.
PayloadsApi ApiPayloadsGet GET /api/Payloads Gets the payloads for the current user.
PayloadsApi ApiPayloadsIdDelete DELETE /api/Payloads/{id} Deletes the specified payload for the current user.
PayloadsApi ApiPayloadsIdGet GET /api/Payloads/{id} Gets the specific payload for the current user.
PayloadsApi ApiPayloadsIdPut PUT /api/Payloads/{id} Updates the specified payload for the current user.
PayloadsApi ApiPayloadsPost POST /api/Payloads Creates a new payload for the current user.
RulesApi ApiRulesGet GET /api/Rules Gets the rules for the current user.
RulesApi ApiRulesIdDelete DELETE /api/Rules/{id} Deletes the specified rule for the current user.
RulesApi ApiRulesIdGet GET /api/Rules/{id} Gets the specific rule for the current user.
RulesApi ApiRulesIdPut PUT /api/Rules/{id} Updates the specified rule for the current user.
RulesApi ApiRulesPost POST /api/Rules Creates a new rule for the current user.
ScanApi ApiScanContentListPost POST /api/Scan/content-list Retrieves the SMAC content list.
ScanApi ApiScanContentPost POST /api/Scan/content Retrieves the SMAC content.
SmacAssociatedUsersApi SmacAssociatedUsersIdGet GET /SmacAssociatedUsers/{id}
SmacsApi ApiSmacsGet GET /api/Smacs Gets the SMAC for the current user.
SmacsApi ApiSmacsIdDelete DELETE /api/Smacs/{id} Deletes the specified SMAC for the current user.
SmacsApi ApiSmacsIdGeneratePost POST /api/Smacs/{id}/generate Generates the SMAC QR Code.
SmacsApi ApiSmacsIdGet GET /api/Smacs/{id} Gets the specific SMAC for the current user.
SmacsApi ApiSmacsIdPngGet GET /api/Smacs/{id}/png Downloads the SMAC QR Code as PNG.
SmacsApi ApiSmacsIdPut PUT /api/Smacs/{id} Updates the specified SMAC for the current user.
SmacsApi ApiSmacsIdSvgGet GET /api/Smacs/{id}/svg Downloads the SMAC QR Code as SVG.
SmacsApi ApiSmacsPost POST /api/Smacs Creates a new SMAC for the current user.
UsersApi ApiUsersAssociatedSmacsGet GET /api/Users/associated-smacs Gets the SMACs associated with the user.
UsersApi ApiUsersAuthenticatePost POST /api/Users/authenticate Performs user authentication.
UsersApi ApiUsersForgotPasswordPost POST /api/Users/forgot-password Initiates password reset procedure.
UsersApi ApiUsersRefreshTokenPost POST /api/Users/refresh-token Retrieves new access token.
UsersApi ApiUsersRegisterPost POST /api/Users/register Register an account.
UsersApi ApiUsersResendEmailConfirmationPost POST /api/Users/resend-email-confirmation Resend email confirmation.
UsersApi ApiUsersRevokeTokenPost POST /api/Users/revoke-token Revokes a refresh token.
UsersApi ApiUsersRolesPost POST /api/Users/roles Gets the authenticated user's roles.
UsersApi ApiUsersUploadProfilePhotoPost POST /api/Users/upload-profile-photo Uploads current user profile photo.
UsersApi ApiUsersUserProfilePost POST /api/Users/user-profile Gets the current user profile.
UtilitiesApi ApiUtilitiesPingGet GET /api/Utilities/ping Checks if the service is alive.
UtilitiesApi ApiUtilitiesVersionGet GET /api/Utilities/version Retrieve the service version.

Documentation for Models

Documentation for Authorization

apiKey

  • Type: API key
  • API key parameter name: X-SMAC-PLATFORM-API-KEY
  • Location: HTTP header

bearer

  • Type: Bearer Authentication

About

Cleaned up version of C# client generated by OpenAPI Generator.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.