sdksio / apimatic-logalty-sdk
This is a sample SDK generated by APIMatic
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.17
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
README
Introduction
API for certificate issuance through Logalty's "Certy" service.
Authentication
This API uses OAuth2 client credentials flow. A pair of keys (client_id / client_secret)
per environment must be requested from the Logalty integration team at integration@logalty.com.
Flow overview
- Authenticate against the OAuth2 server to obtain a Bearer token.
- Create a certificate issuance transaction.
- Query the transaction status.
- Download evidences (images, video, OCR) when available.
- Perform operations (resend access, cancel) if needed.
- Receive event notifications via the Feedback webhook.
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "sdksio/apimatic-logalty-sdk:0.0.1"
Or add it to the composer.json file manually as given below:
"require": { "sdksio/apimatic-logalty-sdk": "0.0.1" }
You can also view the package at: https://packagist.org/packages/sdksio/apimatic-logalty-sdk#0.0.1
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| certyServer | string |
Hostname of the Certy API server Default: 'certy_server' |
| oauth2Server | string |
Hostname of the OAuth2 server Default: 'oauth2_server' |
| environment | Environment |
The API environment. Default: Environment.PRODUCTION |
| timeout | int |
Timeout for API calls in seconds. Default: 30 |
| enableRetries | bool |
Whether to enable retries and backoff feature. Default: false |
| numberOfRetries | int |
The number of retries to make. Default: 0 |
| retryInterval | float |
The retry time interval between the endpoint calls. Default: 1 |
| backOffFactor | float |
Exponential backoff factor to increase interval between retries. Default: 2 |
| maximumRetryWaitTime | int |
The maximum wait time in seconds for overall retrying requests. Default: 0 |
| retryOnTimeout | bool |
Whether to retry on request timeout. Default: true |
| httpStatusCodesToRetry | array |
Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
| httpMethodsToRetry | array |
Http methods to retry against. Default: 'GET', 'PUT' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| bearerAuthCredentials | BearerAuthCredentials |
The Credentials Setter for OAuth 2 Bearer token |
| basicAuthCredentials | BasicAuthCredentials |
The Credentials Setter for Basic Authentication |
The API client can be initialized as follows:
use LogaltyCertificateIssuanceApiCertyLib\Logging\LoggingConfigurationBuilder; use LogaltyCertificateIssuanceApiCertyLib\Logging\RequestLoggingConfigurationBuilder; use LogaltyCertificateIssuanceApiCertyLib\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use LogaltyCertificateIssuanceApiCertyLib\Environment; use LogaltyCertificateIssuanceApiCertyLib\Authentication\BearerAuthCredentialsBuilder; use LogaltyCertificateIssuanceApiCertyLib\Authentication\BasicAuthCredentialsBuilder; use LogaltyCertificateIssuanceApiCertyLib\LogaltyCertificateIssuanceApiCertyClientBuilder; $client = LogaltyCertificateIssuanceApiCertyClientBuilder::init() ->bearerAuthCredentials( BearerAuthCredentialsBuilder::init( 'AccessToken' ) ) ->basicAuthCredentials( BasicAuthCredentialsBuilder::init( 'Username', 'Password' ) ) ->environment(Environment::PRODUCTION) ->certyServer('certy_server') ->oauth2Server('oauth2_server') ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Default Certy API server |
| ENVIRONMENT2 | OAuth2 authentication server |
Authorization
This API uses the following authentication schemes.
List of APIs
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder