Skip to main content

Combeenation API

The Combeenation API is an interface which can be called programmatically with any possible HTTP REST client.

Endpoint​

The endpoint for the API v1 is https://api.combeenation.com/v1

Authentication​

Authenticate each request by setting the Authorization header with a valid API token. Create and manage your API tokens in the company settings. You can have up to two API tokens.

We accept just the API token itself:

"Authorization": "5bNPyHJWpF3PVT0bMho_kOOuPx0RD47pkPjRSsB8uauE6nrie+8eNZhggdwozjzKVqRy4k3xEvQAOHDHAZAoqc=="

or the API token in the Bearer format:

"Authorization": "Bearer 5bNPyHJWpF3PVT0bMho_kOOuPx0RD47pkPjRSsB8uauE6nrie+8eNZhggdwozjzKVqRy4k3xEvQAOHDHAZAoqc=="
warning

Make sure to store your API keys somewhere secure and never share them publicly.

API v1​

For the full URL just concatenate the endpoint URL with the action you want to execute (e.g. https://api.combeenation.com/v1/version).

General​

[GET] /version ... returns information about the API endpoint

Configurations​

[POST] /configurations/{id}/copy ... creates a copy of the configuration with the given {id} within the same configurator
[POST] /configurations/copy ... copies a configuration to any configurator and applies mapping of input values (useful when component names differ)

{
  "id": "170620771536492032", // id of the source configuration
  "targetConfigurator": "MYCONFIGURATOR", // name of the target configurator
  "targetStage": "testing", // (optional) name of a target stage, omit it to use the published configurator
  "inputs": {
    "MyCmp": "CmpRenamed", // src component name : target component name
    "MyCmp2": "MyCmp2"
  }
}

Finishes​

[POST] /finishes/{id}/copy ... copy the finish with the given {id}
[POST] /finishes/copy ... copies a finish to any configurator and applies mapping of input values (useful when component names differ)

{
  "id": "170620771536492032", // id of the source finish
  "targetConfigurator": "MYCONFIGURATOR", // name of the target configurator
  "targetStage": "testing", // (optional) name of a target stage, omit it to use the published configurator
  "inputs": {
    "MyCmp": "CmpRenamed", // src component name : target component name
    "MyCmp2": "MyCmp2"
  }
}