Follow

About the Kapost API

Follow this link to learn about Kapost's API. You will find the following information. 

Interactive API Documentation

Try the Interactive Browser

Authentication

The Kapost API requires the use of a user account. To find the API Token:

  1. Go to your Profile by clicking on your name in the top right corner of your Kapost instance.
  2. Click View Profile
  3. Click Edit Studio Preferences
  4. Select the correct Kapost Instance

There is an API Token section that contains the authentication token credential you need to authenticate when using the API. All actions taken by the API will appear to originate from this user account.

The Kapost API utilizes HTTP Basic Authentication. Using standard basic auth scheme, put the token string into the username field and "x" (or any value) for the password field. The password field is ignored.

URL Structure

https://your_instance.kapost.com/api/v1/resource/

  • SSL is required
  • API Version is the first part of the path

Response Format

All responses are in the json format.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments