API Authentication
LupaSearch offers different authentication methods to securely access its API resources. These resources include, but are not limited to, importing products, updating search query configurations, adding synonyms, and more.
To access these restricted API resources, users can utilize either JWT (JSON Web Token) Access Tokens or API Keys, each serving different purposes and use cases.
JWT (JSON Web Token) Access Tokens are primarily used for authenticating individual user actions. They represent the identity of a user and are typically used in scenarios where user-specific operations are performed.
API Keys are used for server-to-server authentication. They are best suited for situations where an automated system or service requires interaction with our API.
For more information about each authentication method, please refer to the Authentication documentation.
Usage
To access protected API resource the JWT token or API key must be included in the header of your HTTP request.
JWT access token
To use a JWT Access Token, you need to include it in the Authorization header of your HTTP request. The format for this is as follows:
Authorization: Bearer <token>
Example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ...
API key
To use an API key, you need to include it in the X-Lupa-Api-Key header of your HTTP request. The format for this is as follows:
X-Lupa-Api-Key: <key>
Example:
X-Lupa-Api-Key: SOFKt8Xg6b98L30euM0K4vVR34U8y5hoiagU...
Next steps
It's time to create a search index.