Configuration Service

Download OpenAPI specification:Download

E-mail: documentation@emporix.com

General store for tenant-specific information.

You can use the Configuration Service to create two types of configurations:

Global configurations — applicable to all services across the tenant.
Client configurations — associated with particular services.

Key Features:

Store tenant-specific, JSON formatted information, such as redirects or custom error / information messages.

Key Benefits:

Easy-access store for undefined information

Global configurations

Manage Global Configurations

Retrieving configurations

Retrieves a list of configurations.

Required scopes

configuration.configuration_view

SecurityOAuth2

Request

path Parameters

tenant

required

string

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

query Parameters

keys

string

Responses

200

OK

get/{tenant}/configurations

Request samples

Response samples

200

application/json

[{"key": "customer.deletion.redirecturl",
"secured": false,
"value": "https://tenant.com/custDelete?token=",
"version": 1
},
{"key": "customer.passwordreset.redirecturl",
"secured": false,
"value": "https://tenant.com/changePassword?token=",
"version": 1
},
{"key": "customer.changeemail.redirecturl",
"secured": false,
"value": "https://tenant.com/emailChangeConfirm?token=",
"version": 1
},
{"key": "cust.notification.email.from",
"secured": false,
"value": "example_email@emporix.com",
"version": 3
},
{"key": "project_country",
"secured": false,
"value": "EN",
"version": 2
},
{"key": "project_curr",
"secured": false,
"value": "[{\"id\":\"EUR\",\"label\":\"Euro\",\"default\":true,\"required\":true}]",
"version": 3
},
{"key": "project_lang",
"secured": false,
"value": "[{\"id\":\"en\",\"label\":\"English\",\"default\":true,\"required\":true}]",
"version": 2
},
{"key": "taxConfiguration",
"secured": false,
"value": {"taxClassOrder": ["FULL",
"HALF",
"ZERO"
],
"taxClasses": {"FULL": 19,
"HALF": 7,
"ZERO": 0
}
},
"version": 2
},
{"key": "packagingConf",
"secured": false,
"value": {"packagingGroupOptions": ["1_cooling_product",
"2_standard",
"3_fragile"
],
"packagingPositionOptions": ["1_bottom_robust",
"2_bottom_insensitive",
"3_middle_standard",
"4_top_sensitive"
]
},
"version": 2
},
{"key": "storefront.htmlPage",
"secured": false,
"value": "index.html",
"version": 1
},
{"key": "storefront.host",
"secured": false,
"value": "tenant.com",
"version": 1
},
{"key": "unitConf",
"secured": false,
"value": [{"units": {"LTR": {"availableUnitValue": 1,
"conversion": {"MLT": 1000
}
},
"GRM": {"availableUnitValue": 100,
"conversion": {"KGM": 0.001
}
},
"KGM": {"availableUnitValue": 1,
"conversion": {"GRM": 1000
}
},
"MLT": {"availableUnitValue": 100,
"conversion": {"LTR": 0.001
}
}
},
"name": "UnitConfiguration",
"description": "This object holds the unit configurations and the factors to calculate between different units"
}
],
"version": 1
}
]

Creating configurations

Creates new configurations.

Required scopes

configuration.configuration_manage

SecurityOAuth2

Request

path Parameters

tenant

required

string

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Request Body schema: application/json

Array

key	string non-empty Global configuration's key.
	object or string or Array of arrays or boolean Client configuration's value. It can be any valid JSON object.
version	integer Configuration's version.
secured	boolean Default: false Flag indicating whether the configuration should be encrypted.

Responses

201

Created

400

Bad Request

409

Conflict

post/{tenant}/configurations

Request samples

application/json

[{"key": "project_country",
"secured": false,
"value": "DE",
"version": 1
},
{"key": "project_lang",
"secured": false,
"value": "[{\"id\":\"en\",\"label\":\"English\",\"default\":true,\"required\":true},{\"id\":\"de\",\"label\":\"German\",\"default\":false,\"required\":false}]",
"version": 1
}
]

Response samples

201
400
409

application/json

[{"key": "project_country",
"secured": false,
"value": "DE",
"version": 1
},
{"key": "project_lang",
"secured": false,
"value": "[{\"id\":\"en\",\"label\":\"English\",\"default\":true,\"required\":true},{\"id\":\"de\",\"label\":\"German\",\"default\":false,\"required\":false}]",
"version": 1
}
]

Retrieving a configuration

Retrieves a specified configuration.

Required scopes

configuration.configuration_view

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
propertyKey required	string Desired configuration's key.

Responses

200

OK

404

get/{tenant}/configurations/{propertyKey}

Request samples

Response samples

200
404

application/json

{"key": "project_lang",
"secured": false,
"value": "[{\"id\":\"en\",\"label\":\"English\",\"default\":true,\"required\":true}]",
"version": 2
}

Updating a configuration

Updates a specified configuration.

Required scopes

configuration.configuration_manage

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
propertyKey required	string Desired configuration's key.

Request Body schema: application/json

key	string non-empty Global configuration's key.
	object or string or Array of arrays or boolean Client configuration's value. It can be any valid JSON object.
version	integer Configuration's version.
secured	boolean Default: false Flag indicating whether the configuration should be encrypted.

Responses

200

OK

400

Bad Request

409

Conflict

put/{tenant}/configurations/{propertyKey}

Request samples

application/json

{"key": "project_country",
"secured": false,
"value": "AT",
"version": 1
}

Response samples

200
400
409

application/json

{"key": "project_country",
"secured": false,
"value": "AT",
"version": 1
}

Deleting a configuration

Deletes a specified configuration.

Required scopes

configuration.configuration_manage

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
propertyKey required	string Desired configuration's key.

Responses

204

No Content

404

Not Found

delete/{tenant}/configurations/{propertyKey}

Request samples

Response samples

404

application/json

{"details": [{"message": "Couldn't delete the global configuration with the propertyKey ''{propertyKey}'' for the tenant ''{tenant}''"
}
],
"message": "Global configuration could not be found",
"status": 404,
"type": "application/json"
}

Client configurations

Manage Client Configurations

Retrieving client configurations

Retrieves a list of configurations for a specified client.

Required scopes

configuration.configuration_view

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
client required	string Desired client's unique identifier.

query Parameters

keys

string

Responses

200

OK

get/{tenant}/clients/{client}/configurations

Request samples

Response samples

200

application/json

[{"_id": "saas-ag.caas-indexing-service-client_algolia_activation",
"client": "saas-ag.caas-indexing-service-client",
"key": "algolia_activation",
"value": true
},
{"_id": "saas-ag.caas-indexing-service-client_indexing_configuration",
"client": "saas-ag.caas-indexing-service-client",
"key": "indexing_configuration",
"value": {"activePublishedProductIndexing": true,
"activeNonPublishedProductIndexing": true
}
}
]

Creating client configurations

Creates a new client configuration.

Required scopes

configuration.configuration_manage

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
client required	string Desired client's unique identifier.

Request Body schema: application/json

Array

id	string non-empty Client configuration's unique identifier.
client	string non-empty The client to which the configuration applies.
key	string non-empty Client configuration's key.
	object or string or Array of arrays or boolean Client configuration's value. It can be any valid JSON object.

Responses

201

Created

400

Bad Request

409

Conflict

post/{tenant}/clients/{client}/configurations

Request samples

application/json

[{"client": "test_client",
"key": "test_key",
"value": true
}
]

Response samples

201
400
409

application/json

[{"_id": "test_client_test_key",
"client": "test_client",
"key": "test_key",
"value": true
}
]

Retrieving a client configuration

Retrieves a specified client configuration.

Required scopes

configuration.configuration_view

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
client required	string Desired client's unique identifier.
propertyKey required	string Desired configuration's key.

Responses

200

OK

404

get/{tenant}/clients/{client}/configurations/{propertyKey}

Request samples

Response samples

200
404

application/json

{"_id": "saas-ag.caas-indexing-service-client_indexing_configuration",
"client": "saas-ag.caas-indexing-service-client",
"key": "indexing_configuration",
"value": {"activePublishedProductIndexing": true,
"activeNonPublishedProductIndexing": true
}
}

Updating a client configuration

Updates a specified client configuration.

Required scopes

configuration.configuration_manage

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
client required	string Desired client's unique identifier.
propertyKey required	string Desired configuration's key.

Request Body schema: application/json

id	string non-empty Client configuration's unique identifier.
client	string non-empty The client to which the configuration applies.
key	string non-empty Client configuration's key.
	object or string or Array of arrays or boolean Client configuration's value. It can be any valid JSON object.

Responses

200

OK

400

Bad Request

409

Conflict

put/{tenant}/clients/{client}/configurations/{propertyKey}

Request samples

application/json

{"id": "test_client_test_key",
"client": "test_client",
"key": "test_key",
"value": false
}

Response samples

200
400
409

application/json

{"_id": "test_client_test_key",
"client": "test_client",
"key": "test_key",
"value": false
}

Deleting a client configuration

Deletes a specified client configuration.

Required scopes

configuration.configuration_manage

SecurityOAuth2

Request

path Parameters

tenant required	string Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
client required	string Desired client's unique identifier.
propertyKey required	string Desired configuration's key.

Responses

204

No Content

400

Bad Request

404

Conflict

delete/{tenant}/clients/{client}/configurations/{propertyKey}

Request samples

Response samples

400
404

application/json

{"message": "Invalid tenant supplied without proper authorization",
"status": 400,
"type": "application/json"
}