API Documentation Outline:

Introduction:

Welcome to our platform for ordering and monitoring digital products! Our platform is designed to provide customers with an efficient and secure solution for managing their digital product needs. The following manual will guide you through the process of accessing and utilizing our API endpoints.

To begin, you will need to have completed the onboarding process and be an authorized customer. Once you have been granted access, you can securely connect to the API using Basic Authentication.

We hope you find our platform and API to be a valuable tool for your digital product needs. If you have any questions or concerns, please refer to the rest of this manual for more information or contact our support team.

Overview of the API:

There are several endpoints for use:

• product (https://api.supplycharge.net/product) Getting product and pricing information
• balance (https://api.supplycharge.net/balance) Getting your account balance
• order (https://api.supplycharge.net/order) Creating and getting orders

Purpose and functionality of the API:

With our  API you can order our products.  

The /product endpoint allows you to retrieve information about products and their prices. This can include the product name, description, price, and other relevant information. By making a request to this endpoint, you can retrieve a list of all available products and their prices. This information can be used to display the products and prices to your users, or to make decisions about which products to offer.

The /balance endpoint allows you to retrieve information about your account balance, which can be useful for tracking your spending and ensuring that you have enough funds to make purchases.

The /order endpoint allows you to create and retrieve orders. You can make a POST request to this endpoint to create a new order, which can include information such as the product to be purchased, the quantity, and the payment information. You can also make a GET request to this endpoint to retrieve information about existing orders, such as the order status, the products purchased, and the delivery information. This functionality allows you to manage the order process, from creating a new order to delivering the products to your customers.

the API provides a comprehensive set of functionalities for retrieving product and pricing information, checking your account balance, and creating and managing orders. This can help streamline your workflow and provide a more seamless experience for your users.

Find your product

With the following curl command, you can retrieve a list of products from our API: 

Example Request:

Example response:

Filter Products

With the following curl command, you can filter products from the API:

Example request:

curl --request GET \

--url http://api.supplycharge.net/product\

--url http://api.supplycharge.net/product?category=playstation \

- header 'x-api-key: YOUR API TOKEN',

},

Example response

Request your current balance

Our API provides you with the ability to check your account balance at any time. To view your current balance, simply make a GET request to our API. This information can be useful for ensuring that you have sufficient funds before making an order, or for tracking your spending over time.

By regularly checking your balance, you can stay informed about your account status and avoid potential issues related to insufficient funds. With just a few clicks, you can access this information and keep your digital product purchases running smoothly.

Example Request:

Example response:

Create API order

To place an order for a digital product, you will need to provide the product slug and your API key in the header of your order call. Upon successful submission, you will receive your digital product immediately.

Example Request (Scan code):

Response remarks. You can change mode to “production.

Example response:

Get order

Ensure the security of your order information with our API by including valid credentials in the Authorization header of each GET request. The Order/{orderId} endpoint gives you access to all the details of a specific order, allowing you to stay informed and in control.

With a successful GET request, you will receive a comprehensive response containing all the information about the requested order. This includes not just the product details, but also the payment and delivery information, providing you with a complete picture of the order.

Our API is designed to provide quick and convenient access to your order information. Whether you're checking on the progress of a current order or reviewing the details of a completed order, our API offers the information you need, when you need it.

Example response

Test Products

Our platform offers a sandbox mode, which provides a testing environment for the order creation process. This mode allows you to verify the correctness of your order creation process without creating actual orders. 

Error codes

Our API responses use standard HTTP status codes: 2xx status codes indicate success, 4xx status codes indicate invalid input or invalid action on current state, and 5xx status codes indicate a rare error on Personas servers. The response body contains a list of errors with title and details.