Client configurations
Manage Client Configurations
Retrieves a list of clients for a specified tenant.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
OK
GET /configuration/{tenant}/clients HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
"saas-ag.caas-indexing-service-client"
]Retrieves a list of configurations for a specified client.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
OK
GET /configuration/{tenant}/clients/{client}/configurations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
OK
[
{
"_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
}
}
]Creates a new client configuration.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Client configuration unique identifier.
The client to which the configuration applies.
Client configuration key.
Client configuration value. It can be any valid JSON object.
Created
Bad Request
Conflict
POST /configuration/{tenant}/clients/{client}/configurations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56
[
{
"client": "test_client",
"key": "test_key",
"value": true
}
][
{
"_id": "test_client_test_key",
"client": "test_client",
"key": "test_key",
"value": true
}
]Retrieves a specified client configuration.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Desired configuration key.
OK
GET /configuration/{tenant}/clients/{client}/configurations/{propertyKey} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"_id": "saas-ag.caas-indexing-service-client_indexing_configuration",
"client": "saas-ag.caas-indexing-service-client",
"key": "indexing_configuration",
"value": {
"activePublishedProductIndexing": true,
"activeNonPublishedProductIndexing": true
}
}Updates a specified client configuration.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Desired configuration key.
Client configuration unique identifier.
The client to which the configuration applies.
Client configuration key.
Client configuration value. It can be any valid JSON object.
OK
Bad Request
Conflict
PUT /configuration/{tenant}/clients/{client}/configurations/{propertyKey} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95
{
"id": "example_client_example_key",
"client": "example_client",
"key": "example_key",
"value": false
}{
"_id": "example_client_example_key",
"client": "example_client",
"key": "example_key",
"value": false
}Deletes a specified client configuration.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Desired configuration key.
No Content
Bad Request
Conflict
DELETE /configuration/{tenant}/clients/{client}/configurations/{propertyKey} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated
Was this helpful?