APIMatic Core Library Interfaces

Introduction

Definition of the behavior of apimatic/core, apimatic/unirest-php and APIMatic's PHP SDK

Supported PHP Versions

• PHP 7.2
• PHP 7.4
• PHP 8.0
• PHP 8.1
• PHP 8.2

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "apimatic/core-interfaces"

Interfaces

Name	Description
ContextInterface	To save both Request and Response after the completion of response
AuthInterface	To Provide abstraction for all AuthManagers
ApiLoggerInterface	To set up an abstract layer for logging requests and responses
RequestInterface	To get the properties from the instance of Request
RequestSetterInterface	To update the instance of Request
ParamInterface	To Provide abstraction for common functionality of Parameters
NonEmptyParamInterface	An extension of ParamInterface, for validation of non-empty values
TypeValidatorInterface	To Provide abstraction for type validation in Parameters
ResponseInterface	To get the properties from the instance of Response
HttpConfigurations	To hold the default configurations for HttpClient
HttpClientInterface	To provide abstraction to execute API call in HttpClient
ConverterInterface	Holds required converter methods to create SDK classes
ExceptionInterface	Default interface for all the exception models in SDK

Enumerations

Name	Description
AuthGroup	Enumeration for multiple Auth groups
RequestArraySerialization	Enumeration for all ArraySerialization formats
RequestMethod	Enumeration for all possible types of requests
Format	Enumeration for different formats of request body and responses
RetryOption	Enumeration for RetryingOption of each API call