Project description
apimatic-core
Introduction
The APIMatic Core libraries provide a stable runtime that powers all the functionality of SDKs. This includes functionality like the ability to create HTTP requests, handle responses, apply authentication schemes, convert API responses back to object instances, and validate user and server data.
Installation
You will need Python 3.7-3.9 to support this package.
Simply run the command below to install the core library in your SDK. The core library will be added as a dependency your SDK.
pip install apimatic-core
API Call Classes
Name |
Description |
RequestBuilder |
A builder class used to build an API Request |
APICall |
A class used to create an API Call object |
ResponseHandler |
Used to handle the response returned by the server |
Authentication
Name |
Description |
HeaderAuth |
A class supports HTTP authentication through HTTP Headers |
QueryAuth |
A class supports HTTP authentication through query parameters |
AuthGroup |
A helper class to support multiple authentication operation |
And |
A helper class to support AND operation between multiple authentication types |
Or |
A helper class to support OR operation between multiple authentication types |
Single |
A helper class to support single authentication |
Configurations
Name |
Description |
EndpointConfiguration |
A class which hold the possible configurations for an endpoint |
GlobalConfiguration |
A class which hold the global configuration properties to make a successful Api Call |
Decorators
Name |
Description |
LazyProperty |
A decorator class for lazy instantiation |
Factories
HTTP
Logger
Name |
Description |
EndpointLogger |
A class to provide logging for an HTTP request |
Types
Name |
Description |
SerializationFormats |
An Enumeration of Array serialization formats |
DateTimeFormat |
An Enumeration of Date Time formats |
ErrorCase |
A class to represent Exception types |
FileWrapper |
A wrapper to allow passing in content type for file uploads |
Parameter |
A class to represent information about a Parameter passed in an endpoint |
XmlAttributes |
A class to represent information about a XML Parameter passed in an endpoint |
Utilities
Name |
Description |
ApiHelper |
A Helper Class with various functions associated with making an API Call |
AuthHelper |
A Helper Class with various functions associated with authentication in API Calls |
ComparisonHelper |
A Helper Class used for the comparison of expected and actual API response |
FileHelper |
A Helper Class for files |
XmlHelper |
A Helper class that holds utility methods for xml serialization and deserialization. |
Links
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution