Getting Started

The OKZest API uses REST. Our API accepts form-encoded request bodies, returning JSON-encoded responses.

An API key is required to authenticate the request.

1. Create an account at OKZest
2. Create an API key
3. Create a design
4. Make an API call to change some of the content

var data = {
    "design_id": "dcH69PLkb2YctQunAVZLQ",
    "layers": [
        {
            "layer_id": "static-text",
            "color": "#FF5733"
        },        
        {
            "layer_id": "logo",
            "background": "#000000"
        }
    ],
    "background": "#eda32b"
}

fetch('https://api.okzest.com/v1/images', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

Authentication

You can view and manage your API keys from the API page.

Your API keys give access to your design data so be sure to keep them secure. Do not share your secret API keys in public areas such as GitHub or client-side code.

All API requests must be made over HTTPS.

Errors

OKZest uses convential HTTP response codes to indicate success or failure.