API Reference
The Localess API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. You can use the Localess API in test mode, which doesn’t affect your live data. In the API URL, you can use the `version` parameter to access the draft
version of your documents. BaseURLs :
https://.web.app/api/v1/
https://.firebaseapp.com/api/v1/
https:///api/v1/
https://.web.app/api/v1/
Open API Specification
In the Localess application, you can find under the development Sidebar section the Open API menu, where you will find all your API definitions automatically generated with all Schematic.
Focus on your Schematic, and for any integration, you need 3 steps:
Simple download the Open API
Generate Interface and Services
Use them in your application
Authentication
The Localess API uses API keys to authenticate requests. You can view and manage your API keys in the Settings > Access Token tab.
Authentication to the API is performed via token
query parameter.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Errors
Localess uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx
range indicate success. Codes in the 4xx
range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx
range indicate an error with Localess's servers (these are rare).