Getting Started with PagarmeApiSDK

Introduction

Pagarme API

Building

The generated code has dependencies over external libraries like UniRest and JsonMapper. JsonMapper requires docblock annotations like @var, @maps, and @factory to map JSON responses with our class definitions. Hence the docblocks in generated code cannot be disabled by deactivating the PHP configurations like opcache.save_comments. These dependencies are defined in the composer.json file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than or equal to 7.2 installed in your system. Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system. Open command prompt and type composer --version. This should display the current version of the Composer installed if the installation was successful.

• Using command line, navigate to the directory containing the generated files (including composer.json) for the SDK.
• Run the command composer install. This should install all the required dependencies and create the vendor directory in your project directory.

Configuring CURL Certificate Path in php.ini

ℹ️ Note This is for Windows users only.

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

1. Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

[curl]; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
curl.cainfo = PATH_TO/cacert.pem

Installation

The following section explains how to use the PagarmeApiSDKLib library in a new project.

1. Open Project in an IDE

Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on Open in PhpStorm to browse to your generated SDK directory and then click OK.

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test".

Add a PHP file to this project.

Name it "testSDK".

Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.

require_once "vendor/autoload.php";

It is important that the path inside require_once correctly points to the file autoload.php inside the vendor directory created during dependency installations.

After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and use the Controller methods is given in the subsequent sections.

3. Run the Test Project

To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.

Open Settings from File menu.

Select PHP from within Languages & Frameworks.

Browse for Interpreters near the Interpreter option and choose your interpreter.

Once the interpreter is selected, click OK.

To run your project, right click on your PHP file inside your Test project and click on Run.

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
serviceRefererName	string
timeout	int	Timeout for API calls in seconds. Default: 0
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
basicAuthCredentials	BasicAuthCredentials	The Credentials Setter for Basic Authentication

The API client can be initialized as follows:

$client = PagarmeApiSDKClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'BasicAuthUserName',
            'BasicAuthPassword'
        )
    )
    ->serviceRefererName('ServiceRefererName')
    ->build();

Authorization

This API uses the following authentication schemes.

• httpBasic (Basic Authentication)

API Errors

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

List of APIs

• Subscriptions
• Orders
• Plans
• Invoices
• Customers
• Charges
• Recipients
• Tokens
• Transactions
• Transfers
• Payables
• Balance Operations

Classes Documentation

• ApiException
• HttpRequest
• HttpResponse