Overview

Authentication

Generate API key-pair

First, you need to generate Client ID and a Client Secret from your platform back-office, in Shop settings > General settings under the API tab.

HTTP requests

All requests you send to the API must have an http header X-Client-Id containing the Client ID and another header named X-Client-Secret that contains the Client Secret. If the headers are missing or incorrect, a 401 error will be returned.

require 'vendor/autoload.php';

define('KINOW_CLIENT_ID', 'YOUR_CLIENT_ID');
define('KINOW_CLIENT_SECRET', 'YOUR_CLIENT_SECRET');

$configuration = new \Kinow\Client\Configuration();
$configuration->addDefaultHeader('X-Client-Id', KINOW_CLIENT_ID);
$configuration->addDefaultHeader('X-Client-Secret', KINOW_CLIENT_SECRET);

$apiClient = new \Kinow\Client\ApiClient($configuration);

$customersApi = new \Kinow\Client\Api\CustomersApi($apiClient);
try {
    $customers = $customersApi->getCustomers();
    var_dump($customers->getData());
} catch (\Kinow\Client\ApiException $e) {
    var_dump($e->getMessage());
}

const KinowSDK = require('kinow-javascript-sdk')
const clientId = 'YOUR_CLIENT_ID'
const clientSecret = 'YOUR_CLIENT_SECRET'

KinowSDK.ApiClient.instance.defaultHeaders['X-Client-Id'] = clientId
KinowSDK.ApiClient.instance.defaultHeaders['X-Client-Secret'] = clientSecret

const apiCustomers = new KinowSDK.CustomersApi()

apiCustomers.getCustomers()
    .then(data => console.log('API called successfully. Returned data: ' + data))
    .catch(e => console.log(e))

from __future__ import print_function
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

kinow_client_id = "YOUR_CLIENT_ID"
kinow_client_secret = "YOUR_CLIENT_SECRET"

api_client = kinow_client.ApiClient()
api_client.set_default_header("X-Client-Id", kinow_client_id)
api_client.set_default_header("X-Client-Secret", kinow_client_secret)

api_country = kinow_client.CountriesApi(api_client)

try:
    customers = api_customers.get_customers()
    pprint(customers)
except ApiException as e:
    pprint("Exception when calling CustomersApi->get_customers: %s\n" % e)

Make sure to replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with your key-pair previously generated.

Response Format

Responses are returned in JSON.

GET methods requesting lists return a pagination object and a data object. This data object contains all items fetched. When requesting GET for a single item, then object is directly returned.

When using POST or PUT methods to create or update an item, the object created or updated is directly returned, without pagination or list.

Finaly, DELETE methods return an empty response, so you have to check the HTTP code:

• 204 code is used when result is OK
• 4xx codes are used when an error is triggered

Pagination

All GET methods requesting lists can be paginated.

This pagination take two parameters:

• page argument is the number of the page to get
• per_page is the number of the items per page (default value is 50, maximum 100).

Parameters

Name	Details
page	Number of the page to get
per_page	Number of items per page

Response

Name	Details
total	The total number of items returned by the query
current_page	The page being returned
last_page	The number of pages required to list all items
next_page_url	The url of the next page
prev_page_url	The url of the previous page
from	The index of the first item returned on the current page
to	The index of the last item returned on the current pag

Example

Filters

Coming soon...