Api

Explore api documentation.

Pages in this section

  • Shops API Guide

    Welcome to the South Pole’s API documentation. Our API provides a comprehensive set of climate compensation solutions to integrate into your applications. You’ll find comprehensive guides and documentation to help you start working on APIs as quickly as possible, as well as support if you get stuck.

    To get access to our Sandbox environment, or if you have any questions or need further assistance, please contact techsupport@southpole.com

    Why use South Pole’s Climate Compensate API?

    Today, consumers demand that corporations, big and small, be aware of climate change and take action to reduce their impact on the environment. We have the

  • API Flow

  • API Flowcharts

    Overview

    This diagram illustrates the interaction flow between a Next.js application and a Magento 2 API during an e-commerce transaction. It begins with user authentication, followed by product search and selection, leading to the creation of a cart. Once items are added, customer information is captured, and the checkout process can be handled either via direct card payment or through generating a Stripe invoice. After payment confirmation, the order is placed, and the order ID is returned to complete the process.

  • Creating Checkout URL by Using API

    Create Checkout URL

    This API endpoint generates a checkout URL for a specified product. Ensure the project you choose has availability greater than 0.

    Endpoint:

    • URL: http://baseURL/rest/main_EUR/V1/checkout/url
    • Method: POST

    Request Body (JSON):

    {
    "sku": "303730",
    "vintageYear": 2019,
    "qty": 30.2
}

    Parameters:

    • sku: (string, required) — The SKU (Stock Keeping Unit) of the product for which the checkout URL is to be created.
    • vintageYear: (integer, required) — The vintage year of the product.
    • qty: (float, required) — The quantity for the checkout. Ensure the quantity does not exceed the availability of the selected product.

    Response:

  • Postman Collection

    Using the Postman Collection

    To facilitate the integration and testing process, we’ve provided a Postman collection that includes all the API endpoints. This collection allows you to quickly test the API and understand how each endpoint functions.

    Steps to Use the Postman Collection:

    1. Download the Collection: Please download the collection and the environment files to test endpoints.
    2. Import into Postman: Open Postman, and import the downloaded collection.
    3. Set Environment Variables: Make sure to set up your environment variables within Postman to authenticate your requests.
    4. Run Requests: Select an endpoint from the collection, fill in the necessary parameters, and run the request to see the response.

    Note: The collection mentioned below requires an email address and password in the Sandbox environment. To get access, please reach out to us from techsupport@southpole.com.

  • Code Examples

    Github Repository - API with TypeScript

    This GitHub repo showcases the development of custom API integrations for Magento shops using TypeScript. It includes optimized solutions for carbon compensation platforms. Check out the repository for code samples and insights into how you build Magento shop infrastructures.

    Visit the GitHub repository

    API Solution UI Demo for Magento Shops

    Explore how our API solution integrates seamlessly with Magento shops through this interactive demo: Demo Page for Credit Card Payment Flow. The page allows users to: