E-commerce API Features

The Cielo E-commerce API solution was developed using REST technology, which is a market standard and independent of the technology used by your e-commerce platform. This allows integration using a wide variety of programming languages.

To see examples in these languages, check out our Postman Conversion Tutorial.

Among other features, the most notable attributes of the Cielo E-commerce API platform include:

• No proprietary applications required: there is no need to install any applications in the online store environment under any circumstances;
• Simplicity: the protocol used is purely HTTPS;
• Ease of testing: the Cielo platform offers a publicly accessible Sandbox environment, allowing developers to create a test account without the need for prior registration, making it easier and faster to start the integration process;
• Credentials: client credentials, including the affiliation number (MerchantId) and access key (MerchantKey), are handled in the HTTP request header;
• Safety: The exchange of information takes place directly between the store's server and Cielo's server, that is, without the shopper's browser.
• Multiplatform: the integration is performed through a REST Web Service.

Required knowledge: we recommend intermediate knowledge of web programming languages, HTTP/HTTPS requests, and JSON file handling.

To perform operations with the Cielo E-commerce API, you must use your specific key (MerchantId and MerchantKey) in the respective environment endpoints:

To perform an operation, combine the base URL of the environment with the desired operation's URL and send it using the appropriate HTTP verb as described for the operation.

Click here to learn how to generate your MerchantId and MerchantKey on the Cielo website.