Welcome to Kenzo API !
We provide APIs wich enable interactions between our systems.
Sign up Explore our APIs
Kenzo API makes it easier for our partners to have access to our data and integrate theirs in our information system.
Kenzo API mostly follows the REST (REpresentational State Transfer) principles, meaning it defines a set of resources accessible via endpoints through the HTTP protocol, in order to perform requests and receive responses. Besides it provides web services following SOAP (Simple Object Access Protocol) protocol.
To use Kenzo API, you need these elements :
Endpoints - Each endpoints has its own unique path. The base address of Kenzo API is https://esbdevt2.kenzo.info, but you need a specific port that our administrators will give you.
An account - Check out the Authentification section on this page
if you have any question, please contact our Administrators :-)
Getting Started
Main Concepts
Request
Resources describe any object, document, or thing that you may need to store or send to other services accessible by endpoints.
An endpoint is composed of a URL and an HTTP method or verb, and allows to perform an action on a resource.
REST requires that a client make a request to the server in order to retrieve or modify data on the server. A request generally consists of:
An HTTP verb, which defines what kind of operation to perform
A header, which allows the client to pass along information about the request
A path to a resource
An optional message body containing data
There are 4 basic HTTP verbs we use in requests to interact with resources in a REST system:
GET — retrieve a specific resource by id or a collection of resources
POST — create a new resource
PUT — replace a specific resource by id
PATCH — update a specific resource by id
Response
Kenzo API returns all response data as a JSON object
Response Status Codes
200 - OK : The request has succeeded. The client can read the result of the request in the body and the headers of the response.
201 - Created : The request has been fulfilled and resulted in a new resource being created.
202 - Accepted : The request has been accepted for processing, but the processing has not been completed.
204 - No Content : The request has succeeded but returns no message body.
206 - Partial Content : The server is returning partial data of the size requested.
400 - Bad Request : The request could not be understood by the server due to malformed syntax. The message body will contain more information.
401 - Unauthorized : The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials.
403 - Forbidden : The server understood the request, but is refusing to fulfill it.
404 - Not Found : The requested resource could not be found. This error can be due to a temporary or permanent condition.
500 - Internal Server Error : If you don't have an explicit error message, please contact our administrators.
503 - Service Unavailable : The server is currently unable to handle the request due to a temporary condition which will be alleviated after some delay. You can choose to resend the request again.
SOAP
For using SOAP web services, a WSDL (Web Services Definition Language) is needed. It describes the accessible operations and the structured of the message used to call these operations. Please contact our administrators to get access of one of our WSDL.
Authentification
All requests to Kenzo API require authentication. This is achieved by using the Basic authentification method (login/password). To get an account, please contact our administrators.