Getting Started with PagarmeApiSDK

Introduction

Pagarme API

Building

Supported Java version is 8+.

The generated code uses a few Maven dependencies e.g., Jackson, OkHttp, and Apache HttpClient. The reference to these dependencies is already added in the pom.xml file will be installed automatically. Therefore, you will need internet access for a successful build.

• In order to open the client library in Eclipse click on File -> Import.

• In the import dialog, select Existing Java Project and click Next.

• Browse to locate the folder containing the source code. Select the detected location of the project and click Finish.

• Upon successful import, the project will be automatically built by Eclipse after automatically resolving the dependencies.

• After successfully building the project, the client library needs to be installed as a Maven package in your local cache. Right-click on the project, select Show in Local Terminal -> Terminal or use Ctrl + Alt + T to open Terminal.

• In the terminal dialog, run the following command to install client library.

mvn install -Dmaven.test.skip=true -Dmaven.javadoc.skip=true

Installation

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

1. Starting a new project

For starting a new project, click the menu command File > New > Project.

Next, choose Maven > Maven Project and click Next.

Here, make sure to use the current workspace by choosing Use default Workspace location, as shown in the picture below and click Next.

Following this, select the quick start project type to create a simple project with an existing class and a main method. To do this, choose maven-archetype-quickstart item from the list and click Next.

In the last step, provide a Group Id and Artifact Id as shown in the picture below and click Finish.

2. Add reference of the library project

The created Maven project manages its dependencies using its pom.xml file. In order to add a dependency on the PagarmeApiSDKLib client library, double click on the pom.xml file in the Package Explorer. Opening the pom.xml file will render a graphical view on the canvas. Here, switch to the Dependencies tab and click the Add button as shown in the picture below.

Clicking the Add button will open a dialog where you need to specify PagarmeApiSDKLib in Group Id, pagarme-api-sdklib in Artifact Id and 6.8.17 in the Version fields. Once added click OK. Save the pom.xml file.

3. Write sample code

Once the SimpleConsoleApp is created, a file named App.java will be visible in the Package Explorer with a main method. This is the entry point for the execution of the created project. Here, you can add code to initialize the client library and instantiate a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

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
httpClientConfig	Consumer<HttpClientConfiguration.Builder>	Set up Http Client Configuration instance.
basicAuthCredentials	BasicAuthCredentials	The Credentials Setter for Basic Authentication

The API client can be initialized as follows:

PagarmeApiSDKClient client = new PagarmeApiSDKClient.Builder()
    .httpClientConfig(configBuilder -> configBuilder
            .timeout(0))
    .serviceRefererName("ServiceRefererName")
    .basicAuthCredentials(new BasicAuthModel.Builder(
            "BasicAuthUserName",
            "BasicAuthPassword"
        )
        .build())
    .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

SDK Infrastructure

Configuration

• Configuration Interface
• HttpClientConfiguration
• HttpClientConfiguration.Builder

HTTP

• Headers
• HttpCallback Interface
• HttpContext
• HttpBodyRequest
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper
• FileWrapper
• DateTimeHelper