The Zoko API Developer Hub

Welcome to the Zoko API developer hub. You'll find comprehensive guides and documentation to help you start working with Zoko API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Authentication

Zoko API authentication

API Key

The ZOKO API uses API keys to authenticate requests. You can view and manage your API key in the Zoko Dashboard.

The API key needs to passed as a header into every API call you make.
apikey: 'your-api-key-here'

All API requests must be made over HTTPS.

  • Calls made over plain HTTP will fail.
  • API requests without authentication will also fail.

🚧

CAUTION

Your API keys carry many privileges, so be sure to keep them confidential! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Before you start using the API, make sure you have your API key ready. If you haven't received this yet, please contact our helpdesk.

Sample Code

curl --request GET \
  --url https://chat.zoko.io/v2/message/e202794d-15f6-487a-971b-5e2b6ea8a2a5/history \
  --header 'accept: application/json' \
  --header 'apikey: your-api-key-here'
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://chat.zoko.io/v2/message/e202794d-15f6-487a-971b-5e2b6ea8a2a5/history',
  headers: {accept: 'application/json', apikey: 'your-api-key-here'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
import requests

url = "https://chat.zoko.io/v2/message/e202794d-15f6-487a-971b-5e2b6ea8a2a5/history"

headers = {
    "accept": "application/json",
    "apikey": "your-api-key-here"
}

response = requests.request("GET", url, headers=headers)

print(response.text)
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://chat.zoko.io/v2/message/e202794d-15f6-487a-971b-5e2b6ea8a2a5/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'your-api-key-here'

response = http.request(request)
puts response.read_body

Updated about a month ago


Authentication


Zoko API authentication

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.