Easily Integrate
Localizely's API using Konfig's TypeScript SDK
Growing API Companies trust Konfig's SDKs to onboard developers to their API.
First, instantiate the SDK
It only takes a few lines of code.
Then, send your first request
We made it really easy.
Enjoy a buttery smooth developer experience with 4 SDK methods
Parameter
Project ID - Can be found on 'My projects' page
Name of the branch to upload file into. Only in case of activated branching feature.
Language to upload, specified as language code. e.g. en, en_GB or en-GB
If translation in given language should be overwritten with modified translation from uploading file.
If uploading translations, that are added, should be marked as Reviewed. For uploading translations that are only modified it will have effect only if overwrite is set to true.
Optional list of tags to add to new translations from uploading file.
Multiple tags can be defined in a following way: &tag_added_keys=NEW&tag_added_keys=NEW_SPRINT05
Optional list of tags to add to updated translations from uploading file.
Multiple tags can be defined in a following way: &tag_updated_keys=UPDATED&tag_updated_keys=UPDATED_SPRINT05
Optional list of tags to add to removed translations from uploading file.
Multiple tags can be defined in a following way: &tag_removed_keys=REMOVED&tag_removed_keys=REMOVED_SPRINT05
Response
OK, file uploaded
Endpoint
Parameter
Project ID - Can be found on 'My projects' page
Name of the branch to be created
Name of the source branch from which new branch will be created
Response
OK, created
Endpoint
Parameter
Project ID - Can be found on 'My projects' page
Name of the branch to get translation status for. Only in case of activated branching feature.
Response
Endpoint
Parameter
Project ID - Can be found on 'My projects' page
Name of the branch to download file from. Only in case of activated branching feature.
Language to download, specified as language code. e.g. en, en_GB or en-GB. For multiple languages use comma separator. If omitted, all languages are downloaded.
File format
(Only for Java .properties files download) Character encoding. Default is latin_1.
Optional list of tags to be downloaded.
If not set, all string keys will be considered for download.
Multiple tags can be defined in a following way: &include_tags=ANDROID&include_tags=ANDROID_SPRINT05.
Optional list of tags to be excluded from download.
If not set, all string keys will be considered for download.
Multiple tags can be defined in a following way: &exclude_tags=REMOVED&exclude_tags=REMOVED_SPRINT05.
Optional. How you would like empty translations to be exported. Allowed values are empty to keep empty, main to replace with the main language value, or skip to omit.
Response
OK, file returned
Endpoint
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About Localizely
Localizely is a translation management system for agile teams that streamlines software localization. We believe translation management for apps should be easy, so the team can focus on things that bring business value. Developers can easily integrate translations into the apps build process, and managers can easily collaborate with translators. We built Localizely from our experience by working on software projects with 2 to 100 languages.