Skip to main content

Delphi

Know how to install and configure our Delphi SDK to use Efí APIs

Attention!

Requests made to Efí APIs using the Delphi SDK require the certificate generated in your Efí account in .p12 format.


Prerequisites​

  • Applications using the SDK must be compiled on the Windows 32-bit platform.
  • Only desktop applications are supported.
Notes

Originally, the Delphi SDKs were executed and developed in Delphi Rio Community Edition 10.3.

Remember that this SDK was designed to be retrocompatible, meaning it is compatible with both the latest versions of Delphi and older versions. However, Efí will only provide support for win-32 desktop applications developed in Delphi Rio Community Edition 10.3.


Delphi SDK Download​

All demonstration code is available in our GitHub repository at Efí. After downloading, unzip the file to a folder of your choice, and the SDK will be ready for use.


Demo Execution​

After downloading and extracting the files, open the Compiled API folder, and there you will find the executable file:

ApisEFI.exe

Using the Efí SDK​

To use the SDK, simply add the classes to your project and call them as needed.

DLL's

Depending on the Endpoint to be used, you may need to add the DLL's (Available at: \Compiled Api) and external classes (Available at: \Code\External) to your project as well.


The API will always return a JSON string, so any arguments passed to the SDK functions must be of type String.

Before consuming any API endpoint, it is necessary to authenticate with the API using the SDK. For this, you will provide your data:

  • Client_Id;
  • Client_Secret;
  • Environment (sandbox or production);
  • Certificate in .p12 format (Only for the Pix API).
Observation

The "sandbox" environment (or "testing") is the location where Efí provides the integrator to test their integration.

On the other hand, the "production" environment is the "real" environment that your application should be in to generate "real" charges (or "transactions").

REMEMBER: if you activate the "sandbox", use _Client_Id_ and _Client_Secret_ from testing, just as if you are using the production environment, use _Client_Id_ and _Client_Secret_ from that environment.


External Dependencies of the Project​

For the development of the SDK, some external classes were used, available at:


Note

These external classes are already included in our project in the "Utils/External" folder.

Last updated on