Skip to main content

Getting Started with Apimatic API

Introduction

This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install sdksio-apimatic-sdk==3.0.1

You can also view the package at: https://pypi.python.org/pypi/sdksio-apimatic-sdk/3.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
user_agent str
custom_url str The testing domain for the API
Default: "https://localhost:44301/api"
environment Environment The API environment.
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.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
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.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
custom_header_authentication_credentials CustomHeaderAuthenticationCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from apimaticapi.apimaticapi_client import ApimaticapiClient
from apimaticapi.configuration import Environment
from apimaticapi.http.auth.custom_header_authentication import CustomHeaderAuthenticationCredentials
from apimaticapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from apimaticapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from apimaticapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = ApimaticapiClient(
    user_agent='user-agent',
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        authorization='Authorization'
    ),
    environment=Environment.PRODUCTION,
    custom_url='https://localhost:44301/api',
    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

from apimaticapi.apimaticapi_client import ApimaticapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ApimaticapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization 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
TESTING -

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for sdksio-apimatic-sdk 3.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sdksio-apimatic-sdk 3.0.1
File Size Uploaded Provenance Actions
sdksio_apimatic_sdk-3.0.1.tar.gz 30.8 kB Without provenance Details for sdksio_apimatic_sdk-3.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sdksio-apimatic-sdk 3.0.1
File Interpreter ABI Platform Actions
sdksio_apimatic_sdk-3.0.1-py3-none-any.whl Python 3 none any Details for sdksio_apimatic_sdk-3.0.1-py3-none-any.whl

Total release size: 95.6 kB

Release files / sdksio_apimatic_sdk-3.0.1.tar.gz

Download URL sdksio_apimatic_sdk-3.0.1.tar.gz
Size 30.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e557a4e4ad86a280d5420586b7992ce3da4f74ea3e55f44d808f5eb1bad16bcb
BLAKE2b-256 checksum
How to use checksums
eaae7bea373dc9bc26ab8445249a7397990ba31b97a7dc5462511a754f027850
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / sdksio_apimatic_sdk-3.0.1-py3-none-any.whl

Download URL sdksio_apimatic_sdk-3.0.1-py3-none-any.whl
Size 64.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
207424191e5d80962f323737e940b4f6e366bcff381e35d14dc4667fcbe9c37c
BLAKE2b-256 checksum
How to use checksums
cfb80a9729ff20d94c6946adeef58d91f133fe66a736a30580e3df8f49fdb078
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for sdksio-apimatic-sdk 3.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page