Localazy API reference.
The Localazy API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Run this API in Postman π
You can fork the API collection into your own workspace or browse its full content here.
Libraries π
Weβre maintaining the @localazy/ts-api
library which wraps all the following API resources.
Base url π
Localazy API is available at https://api.localazy.com, and all endpoints in this document are relative to this base URL.
https://api.localazy.com
Authentication π
Endpoints reference π
Learn what options are available when using Localazy API.
List projects π
[GET] /projects
Import content to a project π
[POST] /projects/{projectId}/import
List available file types π
[GET] /import/formats
Learn how to get a list of available file types for importing strings including their parameters.
List files in project π
[GET] /projects/{projectId}/files
List file content π
[GET] /projects/{projectId}/files/{fileId}/keys/{lang}
Learn how to get all translations in a given language via Localazy API
Delete source key π
[DELETE] /projects/{projectId}/keys/{keyId}
Update source key π
[PUT] /projects/{projectId}/keys/{keyId}
Learn how to change properties of a given source key via Localazy API
List all glossary items π
[GET] /projects/{projectId}/glossary
Get glossary item π
[GET] /projects/{projectId}/glossary/{id}
Learn how to retreive a single glossary item via Localazy API
Delete glossary item π
[DELETE] /projects/{projectId}/glossary/{id}
Create glossary item π
[POST] /projects/{projectId}/glossary
Update glossary item π
[PUT] /projects/{projectId}/glossary
List webhooks configuration π
[GET] /projects/{projectid}/webhooks
Learn how to retreive webhook configuration via Localazy API
Update webhooks configuration π
[POST] /projects/{projectid}/webhooks