Metadata-Version: 2.4
Name: apimatic-logalty-sdk
Version: 0.0.1
Summary: This is a sample SDK generated by APIMatic
Author-email: developer sdksio <developer+sdksio@apimatic.io>
Project-URL: Documentation, https://apimatic.io
Keywords: apimatic,sdksio
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
Requires-Dist: python-dotenv<2.0,>=0.21
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


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

```bash
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.](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| certy_server | `str` | Hostname of the Certy API server<br>*Default*: `"certy_server"` |
| oauth_2_server | `str` | Hostname of the OAuth2 server<br>*Default*: `"oauth2_server"` |
| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **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. <br> **Default: 30** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **Default: ["GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |

The API client can be initialized as follows:

### Code-Based Client Initialization

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

```python
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](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) 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)`](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
* [`basicAuth (Basic Authentication)`](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md)

## List of APIs

* [Certificate Requests](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/controllers/certificate-requests.md)
* [Authentication](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/controllers/authentication.md)
* [Evidence](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/controllers/evidence.md)
* [Operations](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/controllers/operations.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/http-request.md)

### Utilities

* [ApiResponse](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/api-response.md)
* [ApiHelper](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/apimatic-logalty-python-sdk/tree/0.0.1/doc/unix-date-time.md)

