Pagarme API
You must have Python 3 >=3.7, <= 3.11 installed on your system to install and run this SDK. This SDK package depends on other Python packages like pytest, jsonpickle etc. These dependencies are defined in the requirements.txt file that comes with the SDK. To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.
Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.
- Using command line, navigate to the directory containing the generated files (including
requirements.txt) for the SDK. - Run the command
pip install -r requirements.txt. This should install all the required dependencies.
The following section explains how to use the pagarmeapisdk library in a new project.
Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on Open in PyCharm to browse to your generated SDK directory and then click OK.
The project files will be displayed in the side bar as follows:
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test".
Add a python file to this project.
Name it "testSDK".
In your python file you will be required to import the generated python library using the following code lines
from pagarmeapisdk.pagarmeapisdk_client import PagarmeapisdkClientAfter this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.
To run the file within your test project, right click on your Python file inside your Test project and click on Run
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
service_referer_name |
str |
|
http_client_instance |
HttpClient |
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'] |
basic_auth_credentials |
BasicAuthCredentials |
The credential object for Basic Authentication |
The API client can be initialized as follows:
client = PagarmeapisdkClient(
service_referer_name='ServiceRefererName',
basic_auth_credentials=BasicAuthCredentials(
username='BasicAuthUserName',
password='BasicAuthPassword'
),
environment=Environment.PRODUCTION
)This API uses the following authentication schemes.
Here is the list of errors that the API might throw.
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | Invalid request | ErrorException |
| 401 | Invalid API key | ErrorException |
| 404 | An informed resource was not found | ErrorException |
| 412 | Business validation error | ErrorException |
| 422 | Contract validation error | ErrorException |
| 500 | Internal server error | ErrorException |