Client configurations
Was this helpful?
Was this helpful?
Manage Client Configurations
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
GET /configuration/{tenant}/clients HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
"saas-ag.caas-indexing-service-client"
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
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
}
}
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Desired configuration's key.
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
}
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Desired configuration's key.
DELETE /configuration/{tenant}/clients/{client}/configurations/{propertyKey} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Client configuration's unique identifier.
The client to which the configuration applies.
Client configuration's key.
Client configuration's value. It can be any valid JSON object.
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
}
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Desired client's unique identifier.
Desired configuration's key.
Client configuration's unique identifier.
The client to which the configuration applies.
Client configuration's key.
Client configuration's value. It can be any valid JSON object.
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: 83
{
"id": "test_client_test_key",
"client": "test_client",
"key": "test_key",
"value": false
}{
"_id": "test_client_test_key",
"client": "test_client",
"key": "test_key",
"value": false
}