Indexing Service (v1)

Download OpenAPI specification:Download

E-mail: documentation@emporix.com

The indexing service allows you to manage indexing configuration. Currently supported index providers:

Configuration

Create a new configuration

Creates a new index configuration. Currently supported providers:

Identifier of a newly created configuration is a provider name.

SecurityOAuth2
Request
path Parameters
tenant
required
string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Request Body schema: application/json
searchKey
string

API Key used for search purposes.

applicationId
string

Application id of an indexer provider.

indexName
string

Identifier of an index.

provider
string

Index provider name. Supported providers: ALGOLIA

Value: "ALGOLIA"
active
boolean

Indicates if the configuration is active or not.

writeKey
string

API key used for write purposes.

Responses
201

Created

400

Request was syntactically incorrect. Details will be provided in the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

post/{tenant}/configurations
Request samples
application/json
{
  • "active": true,
  • "searchKey": "84dc4886f81f805c42bdd89d64de751a",
  • "applicationId": "8AP2HABA2I",
  • "indexName": "exampleTenant",
  • "writeKey": "51ebe89215dddcf85e5dacd5643d17e7",
  • "provider": "ALGOLIA"
}
Response samples
application/json
{
  • "id": "ALGOLIA"
}

Get all configurations

Retrieves all configurations of index providers. The returned response contains search and write keys.

SecurityOAuth2
Request
path Parameters
tenant
required
string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Responses
200
401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

get/{tenant}/configurations
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get configuration by provider name
Retrieves a single configuration by a provider name. Currently supported providers:


    

  • ALGOLIA
    • 



SecurityOAuth2 
Request 
path Parameters
tenant
required
string  [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$
The tenant that the caller is acting upon.


Please note that this value is always lowercase.


 
provider
required
string
Provider name. Currently supported providers: ALGOLIA


 
Responses 
200
401
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.


403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.


404
Resource has not been found.


get/{tenant}/configurations/{provider}
Request samples 
Response samples 
application/json
{
  • "active": true,
  • "searchKey": "84dc4886f81f805c42bdd89d64de751a",
  • "applicationId": "8AP2HABA2I",
  • "indexName": "exampleTenant",
  • "writeKey": "51ebe89215dddcf85e5dacd5643d17e7",
  • "provider": "ALGOLIA"
}
Update configuration by provider name
Updates an existing index configuration.


SecurityOAuth2 
Request 
path Parameters
tenant
required
string  [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$
The tenant that the caller is acting upon.


Please note that this value is always lowercase.


 
provider
required
string
Provider name. Currently supported providers: ALGOLIA


 
Request Body schema: application/json
searchKey
string
API Key used for search purposes.


 
applicationId
string
Application id of an indexer provider.


 
indexName
string
Identifier of an index.


 
provider
string
Index provider name. Supported providers: ALGOLIA


 Value: "ALGOLIA"  
active
boolean
Indicates if the configuration is active or not.


 
writeKey
string
API key used for write purposes.


 
Responses 
204
Configuration updated


400
Request was syntactically incorrect. Details will be provided in the response payload.


403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.


404
Resource has not been found.


put/{tenant}/configurations/{provider}
Request samples 
application/json
{
  • "active": true,
  • "searchKey": "84dc4886f81f805c42bdd89d64de751a",
  • "applicationId": "8AP2HABA2I",
  • "indexName": "exampleTenant",
  • "writeKey": "51ebe89215dddcf85e5dacd5643d17e7",
  • "provider": "ALGOLIA"
}
Response samples 
application/json
{
  • "code": 400,
  • "status": "Bad Request",
  • "message": "The provider ALGOLIA2 is not supported."
}
Delete configuration
Deletes the configuration based on the provider name.


SecurityOAuth2 
Request 
path Parameters
provider
required
string
Provider name. Currently supported providers: ALGOLIA


 
tenant
required
string  [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$
The tenant that the caller is acting upon.


Please note that this value is always lowercase.


 
Responses 
204
Configuration deleted


401
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.


403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.


404
Resource has not been found.


delete/{tenant}/configurations/{provider}
Request samples 
Response samples 
application/json
{
  • "fault": {
    }
}
Public Configuration
Get all public configurations
Retrieves all configurations of index providers. The returned response contains only search keys. Write keys are not returned.


SecurityOAuth2 
Request 
path Parameters
tenant
required
string  [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$
The tenant that the caller is acting upon.


Please note that this value is always lowercase.


 
Responses 
200
401
Unauthorized


get/{tenant}/public/configurations
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get public configuration
Retrieves a single public configuration by a provider name. Currently supported providers:


    

  • ALGOLIA
    • 



SecurityOAuth2 
Request 
path Parameters
tenant
required
string  [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$
The tenant that the caller is acting upon.


Please note that this value is always lowercase.


 
provider
required
string
Provider name. Currently supported providers: ALGOLIA


 
Responses 
200
OK


401
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.


404
Resource has not been found.


get/{tenant}/public/configurations/{provider}
Request samples 
Response samples 
application/json
{
  • "active": true,
  • "searchKey": "84dc4886f81f805c42bdd89d64de751a",
  • "applicationId": "8AP2HABA2I",
  • "indexName": "exampleTenant",
  • "provider": "ALGOLIA"
}
Reindex
Reindex
Triggers indexing process of products for the tenant. The reindex works with the following modes:


    

  • FULL - all products will be reindexed
    • 



SecurityOAuth2 
Request 
path Parameters
tenant
required
string
 
Request Body schema: application/json
mode
string
Indicates reindex mode. Supported modes: FULL.


 Value: "FULL"  
Responses 
204
400
Request was syntactically incorrect. Details will be provided in the response payload.


401
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.


403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.


post/{tenant}/reindex
Request samples 
application/json
{
  • "mode": "FULL"
}
Response samples 
application/json
{
  • "code": 400,
  • "status": "Bad Request",
  • "message": "The provider ALGOLIA2 is not supported."
}