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