Skip to main content

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 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

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.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-logalty-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apimatic-logalty-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_logalty_sdk-0.0.1.tar.gz 34.6 kB Without provenance Details for apimatic_logalty_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apimatic-logalty-sdk 0.0.1
File Interpreter ABI Platform Actions
apimatic_logalty_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for apimatic_logalty_sdk-0.0.1-py3-none-any.whl

Total release size: 110.7 kB

Release files / apimatic_logalty_sdk-0.0.1.tar.gz

Download URL apimatic_logalty_sdk-0.0.1.tar.gz
Size 34.6 kB
Tags Source
SHA-256 checksum
How to use checksums
52b22e917eee9c6984044061d110dc8daf551b69ea194bbf0ae845e253049089
BLAKE2b-256 checksum
How to use checksums
c62ecff989398fc8c18eb970b0295a8d2651129e052f31670155ea288c46efd5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_logalty_sdk-0.0.1-py3-none-any.whl

Download URL apimatic_logalty_sdk-0.0.1-py3-none-any.whl
Size 76.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
27d4db5308b63d1b7d83fef831bfe0edd5dec764f99acd40107546b2cb355d9b
BLAKE2b-256 checksum
How to use checksums
1c96efcaa98b1ad911f4c9c47ab53427b18807a267ff7a4d00bd037364d6cdaa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-logalty-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page