HTTP API

Eko provides a set of APIs to support customers who want a deeper personalization of eko projects within their applications. Once your app has been registered via eko representative, the HTTP API allows to override features of one of your project, or a set of projects using a config file.

Base URL: api.eko.com/

API Endpoints:



/v1/projects/{projectId}

Param Type Description
projectId string Id of the project object you wish to get

GET

Retrieve the project object.
Returns a project (JSON object).



Our Models

Example Responses


Status Description Body
200 Success
{
“success”: true,
“status”: 200,
“data”: {
“type”: “object”
},
“message”: “Successful”
}
400 Payload does not conform with the model
{
“statusCode”: 400,
“error”: “Bad Request”,
“message”: “\”value\” must be an object”
}
401 Authentication token is missing
{
“statusCode”: 401,
“error”: “Unauthorized”,
“message”: “Missing authentication”
}
403 Un-authorized route
{
“statusCode”: 403,
“error”: “Forbidden”,
“message”: “You do not have permissions for that operation”
}
404 Item not found
{
“status”: 404,
“success”: false,
“message”: “Item not found”
}
500 Item failed schema validation or unknown error
{
“status”: 500,
“success”: false,
“message”: “Failed for unknown reason”
}
Rate this page: X
Tell us more!