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

1. Authenticate against the OAuth2 server to obtain a Bearer token.
2. Create a certificate issuance transaction.
3. Query the transaction status.
4. Download evidences (images, video, OCR) when available.
5. Perform operations (resend access, cancel) if needed.
6. 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:

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

Authorization

This API uses the following authentication schemes.

• bearerAuth (OAuth 2 Bearer token)
• basicAuth (Basic Authentication)

List of APIs

• Certificate Requests
• Authentication
• Evidence
• Operations

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse