fortis-apimatic-sdk 1.0.0

SDKs for fortis by APIMatic

Getting Started with Fortis API

Install the Package

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

pip install fortis-apimatic-sdk==1.0.0

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

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt pytest

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
environment	Environment	The API environment. Default: Environment.SANDBOX
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: 60
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.
user_id_credentials	UserIdCredentials	The credential object for Custom Header Signature
user_api_key_credentials	UserApiKeyCredentials	The credential object for Custom Header Signature
developer_id_credentials	DeveloperIdCredentials	The credential object for Custom Header Signature
access_token_credentials	AccessTokenCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

from fortisapi.configuration import Environment
from fortisapi.fortisapi_client import FortisapiClient
from fortisapi.http.auth.access_token import AccessTokenCredentials
from fortisapi.http.auth.developer_id import DeveloperIdCredentials
from fortisapi.http.auth.user_api_key import UserApiKeyCredentials
from fortisapi.http.auth.user_id import UserIdCredentials

client = FortisapiClient(
    user_id_credentials=UserIdCredentials(
        user_id='user-id'
    ),
    user_api_key_credentials=UserApiKeyCredentials(
        user_api_key='user-api-key'
    ),
    developer_id_credentials=DeveloperIdCredentials(
        developer_id='developer-id'
    ),
    access_token_credentials=AccessTokenCredentials(
        access_token='access-token'
    ),
    environment=Environment.SANDBOX
)

Environment-Based Client Initialization

from fortisapi.fortisapi_client import FortisapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = FortisapiClient.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
SANDBOX	Default
PRODUCTION	-

Authorization

This API uses the following authentication schemes.

• user-id (Custom Header Signature)
• user-api-key (Custom Header Signature)
• developer-id (Custom Header Signature)
• access-token (Custom Header Signature)

List of APIs

• Async Processing
• Declined Recurring Transactions
• Device Terms
• Full Boarding
• 3 DS Authentication
• 3 DS Transactions
• Merchant Deposits
• On Boarding
• Payment Card Reader Token
• Quick Invoices
• Transaction ACH Retries
• Transactions-ACH
• Transactions-Cash
• Transactions-Credit Card
• Transactions-EBT Card
• Transactions-Read
• Level 3 Data
• Transactions-Updates
• User Verifications
• Apple Pay Validate Merchant
• Merchant Details
• Batches
• Contacts
• Elements
• Locations
• Paylinks
• Recurring
• Signatures
• Tags
• Terminals
• Tickets
• Tokens
• Users
• Webhooks

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime