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:

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

Authorization

This API uses the following authentication schemes.

• Authorization (Custom Header Signature)

List of APIs

• Code Generation-External APIs
• Docs Portal Management
• Docs Portal Generation-Async
• API Validation-External APIs
• API Validation V2-External APIs
• SDK Generation-Async
• Transformation

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime