Appearance
Headers
Headers are keys for unlocking god powers.
API Key
API Keys are designed for third-party integrations and server-to-server communications. Each tenant can create one or more API Keys with specific permissions configured through the back-office.
Manager Access Token
Directly connected with TeamSystem ID, this token ensures you can communicate with almost everything, including Auth API, Core API, and other services. Manager Access Tokens are per-tenant role-based credentials.
Customer Access Token
Personal access tokens generated during customer login. These Laravel Sanctum tokens allow customers to perform authenticated actions within the Store API, such as managing their profile or placing orders.
We are actually working for a Partner Access Token, but ssssshhhhh! It may takes time to appear!
Middlewares
X-Tenant
Identifies the specific store (tenant) you're accessing. This header is required for multi-tenant operations and routes your request to the correct store context. The value is a UUID that uniquely identifies your store within the TSCommerce ecosystem.
X-API-Key
Acts as an override of the standard access token system. Each tenant can create one or more API Keys with customized permissions. This header provides authentication for server-to-server integrations without requiring user-specific tokens.
X-Authorization
The actual bypass of the standard access token flow. This header is obtained by getting an authentication code, which requires both X-Tenant and X-API-Key headers. Once obtained, the authorization code provides authenticated access to API resources based on the permissions configured for the API Key.
X-Locale
Specifies the language for API response messages and validation errors. If not specified, the API defaults to en-US. This header allows you to localize error messages, notifications, and other text responses to match your application's language requirements.
The locale format follows the ISO 639-1 (language code) and ISO 3166-1 (country code) standards, combined as language-COUNTRY (e.g., en-US, it-IT).
Available Languages:
| Locale Code | Language |
|---|---|
en-US | English (default) |
it-IT | Italian |
