apimatic-core-interfaces
Introduction
This project contains the abstract layer for APIMatic's core library. The purpose of creating interfaces is to separate out the functionalities needed by APIMatic's core library module. The goal is to support scalability and feature enhancement of the core library and the SDKs, while avoiding breaking changes by reducing tight coupling between modules.
Version Supported
Currently, APIMatic supports Python version 3.7+, hence the apimatic-core-interfaces package requires the same version support.
Installation
Run the following command in your SDK (the apimatic-core-interfaces package will be added as a dependency):
pip install apimatic-core-interfaces
Interfaces
| Name | Description |
|---|---|
HttpClient |
Saves both request and response after the completion of response. |
ResponseFactory |
Converts the client-adapter response into a custom HTTP response. |
Authentication |
Sets up methods for the validation and application of the required authentication scheme. |
UnionType |
Sets up methods for the validation and deserialization of OneOf/AnyOf union types. |
Logger |
An interface for the generic logger facade. |
ApiLogger |
An interface for logging API requests and responses. |
SignatureVerifier |
Defines the contract for verifying the authenticity of incoming events or webhook requests. |
Types
| Name | Description |
|---|---|
Request |
Framework-agnostic request model capturing headers, method, path, body, and raw bytes. |
SignatureVerificationResult |
Provides a structured result of the verification process, including success, failure, and error details. |
Enumerations
| Name | Description |
|---|---|
HttpMethodEnum |
Enumeration containing HTTP methods (GET, POST, PATCH, DELETE). |
1 maintainer
Metadata
1 maintainer
Release files for apimatic-core-interfaces 0.1.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| apimatic_core_interfaces-0.1.8.tar.gz | 7.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| apimatic_core_interfaces-0.1.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.8 kB
Release files / apimatic_core_interfaces-0.1.8.tar.gz
| Download URL | apimatic_core_interfaces-0.1.8.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
67c4ddbd5d9df92f5d8241cf4258762422d4b3f204b8d353fc25b4a95cb66ac0
|
|
BLAKE2b-256 checksum How to use checksums |
a80a88f7d746eca4ae987d2f9a11235dbff41e5abfe901da2f3b07e463394e10
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.24
|
Release files / apimatic_core_interfaces-0.1.8-py3-none-any.whl
| Download URL | apimatic_core_interfaces-0.1.8-py3-none-any.whl |
|---|---|
| Size | 11.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d8d42ab60f3bc5840c9fd414af8ddfd9bee3e5ab7a73d4340a814ea92a5c1dd1
|
|
BLAKE2b-256 checksum How to use checksums |
0e53de725c86ff3b642b07ae6afb487e98215bf6a9eb1cb786f4b99a4b385945
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.24
|
