📦 Localazy API Client

Node.js module that allows you to easily interact with the Localazy API.

🔧 Install

npm install @localazy/api-client
# or you can use yarn or pnpm

🚀 Usage

ESM

import { ApiClient } from '@localazy/api-client';

const json = { en: { tooltip: 'Elegant unicorn' } }; // Get text to translate.

const api = new ApiClient({ authToken: 'your-project-token' }); // Create Api client.
const project = await api.projects.first(); // Get Localazy project.
const file = await api.import.json({ project, json }); // Import source keys.
const fr = await api.export.json({ project, file, langs: ['fr'] }); // Export translated keys.

console.log(fr); // 🦄 { fr: { tooltip: 'Licorne élégante' } }

TypeScript

import { ApiClient, Project, I18nJson, Locales } from '@localazy/api-client';

const json: I18nJson = { en: { tooltip: 'Elegant unicorn' } };

const api: ApiClient = new ApiClient({ authToken: 'your-project-token' });
const project: Project = await api.projects.first();
const file: File = await api.import.json({ project, json: json });
const fr: I18nJson = await api.export.json({ project, file, langs: [Locales.FRENCH] });

🔐 Project Token

You can obtain the project token at https://localazy.com/developer/tokens.

The project token is permitted to read and write to the single project.

📚 Documentation

• API Client reference
• Examples
• Migration guide from ts-api@1.x.x to api-client@2.0.0
• Changelog

ℹ️ Links

• Localazy API documentation
• Articles about the Localazy API

🛟 Support

Join the Localazy Discussion Forum to discuss all things localization.

If you encounter any problems or have questions, you can use our forum, GitHub issues or contact us at team@localazy.com.

❤️ Localazy Ecosystem

Check out other npm packages from Localazy:

	NPM package	Description
	@localazy/cli	Localazy CLI tool.
	@localazy/api-client	Localazy API client.
	@localazy/languages	List of all languages supported by Localazy.
	@localazy/strapi-plugin	The official Localazy Strapi plugin.

Discover all available integration options and localization examples.

📜 License

Code released under the MIT license.