Quickstart

This guide will get you all set up and ready to use the KineticPay API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Before you can make requests to the KineticPay API, you will need to grab your API key from your dashboard. You find it under API Key.

API endpoint

The base URL for our API is:

https://manage.kineticpay.my/api/v2

All API requests should be made to this base URL.

Headers

To ensure successful communication with our API, it is important to include the following headers in all your requests:

Content-Type: application/json: This header specifies that the content of your request is in JSON format. It tells the server how to interpret the request payload.
Accept: application/json: This header indicates that you expect the response from the server to be in JSON format. It allows the server to format the response accordingly.

Including these headers in your API requests is crucial for proper data exchange and interpretation.

Rate Limit

A rate limit is set for every endpoint to allow fair usage for each users.

The rate limit is 60 requests/minute. All request to our endpoint are count. 60 requests/minute limit will be priced to fair usage when we have announced a paid API model.

Additionally, we send X-RateLimit-Limit and X-RateLimit-Remaining header for each requests.

Once you have exceeded the rate limit, you will receive 429 HTTP Status Code indicating Too Many Requests.

Making first API request

To make your first API request, follow the example below:

GET

/ping

curl --location 'http://www.kineticpay.test/api/v2/ping' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY'

After sending the request, if it is successful, you should receive a response with the message pong

Response

{
  "message": "pong"
}

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the KineticPay API: