Use this guide to get started with the Kaimo API. Feel free to reach out if you need a custom solution extending this service.

Quick start

All you need is an api key and your terminal to get started.

Get your API Key

Head on over to https://www.mykaimo.com/account and get your development API Key.

Postman Documentation

https://documenter.getpostman.com/view/12132882/Uyxkk624

Your First Job Request

After identifying the product you wish to render, retrieve the sku value from the product and get a URL to an image you want to apply to it. A requests output key value pair describes the views you wish to have rendered. The designs array describes the image, and the area from the product to apply it. The variants array descirbes all of the skus to render in the area.

curl --location --request POST 'https://dev.mykaimo.com/jobs' \
--header 'X-Amz-Security-Token: your-api-key' \
--header 'Content-Type: application/json' \
--data-raw '    {
        "variants": ["PZ02H"],
        "designs": [
            {
                "filename": "eye-5248678__340.jpg",
                "fileurl":"https://cdn.pixabay.com/photo/2020/06/01/22/23/eye-5248678__340.jpg",
                "area": "front",
                "mime": "image/png"
            }
            ],
        "output": ["front"]
    }'

Retrieve your Images

After a minute or two, you can retrieve your images using the job id from the job request

curl --location --request GET 'https://dev.mykaimo.com/images/your-job-id' \
--header 'X-Amz-Security-Token: your-api-key'

Publish your first product

Finally, you can publish your product to Shopify

curl --location --request PUT 'https://dev.mykaimo.com/shopify' \
--header 'X-Amz-Security-Token: your-api-key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "store": "your-shopify-store-handle",
    "access": your-shopify-store-access-token,
    "job": "your-job-id"
}'

Basic usage limits

Develop - rate limits coming soon Production - rate limits coming soon

Getting help

We are on call monday through friday 9 to 5pm pacific time to answer questions. We are a small team, so it may take up to 48 hours for us to respond. If you are in need of more critical event support, we are available for a monthly retainer fee. Please contact Nick at nick@mykaimo.com if you are interested in additional support and services.

Submit an issue

Send support requests to nick@mykaimo.com. Please include all relevant information in your submission including your environment, examples files, and a summary of your expected result.