apimatic-logalty-sdk 0.0.1

This is a sample SDK generated by APIMatic

Getting Started with Logalty Certificate Issuance API (Certy)

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 [e-mail].

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

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install apimatic-logalty-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/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
certy_server	str	Hostname of the Certy API server Default: "certy_server"
oauth_2_server	str	Hostname of the OAuth2 server Default: "oauth2_server"
environment	Environment	The API environment. Default: Environment.PRODUCTION
http_client_instance	Union[Session, HttpClientProvider]	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 30
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ["GET", "PUT"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
bearer_auth_credentials	BearerAuthCredentials	The credential object for OAuth 2 Bearer token
basic_auth_credentials	BasicAuthCredentials	The credential object for Basic Authentication

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from logaltycertificateissuanceapicerty.configuration import Environment
from logaltycertificateissuanceapicerty.http.auth.basic_auth import BasicAuthCredentials
from logaltycertificateissuanceapicerty.http.auth.bearer_auth import BearerAuthCredentials
from logaltycertificateissuanceapicerty.logaltycertificateissuanceapicerty_client import LogaltycertificateissuanceapicertyClient
from logaltycertificateissuanceapicerty.logging.configuration.api_logging_configuration import LoggingConfiguration
from logaltycertificateissuanceapicerty.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from logaltycertificateissuanceapicerty.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = LogaltycertificateissuanceapicertyClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    basic_auth_credentials=BasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    environment=Environment.PRODUCTION,
    certy_server='certy_server',
    oauth_2_server='oauth2_server',
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from logaltycertificateissuanceapicerty.logaltycertificateissuanceapicerty_client import LogaltycertificateissuanceapicertyClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = LogaltycertificateissuanceapicertyClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

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.

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

List of APIs

• Certificate Requests
• Authentication
• Evidence
• Operations

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime