Skip to main content

Lokalise

Lokalise is a cloud-based localization and translation management platform designed for agile teams, providing comprehensive tools for managing multilingual content, coordinating translation workflows, and ensuring consistent localization across applications and websites for global market expansion.

Lokalise icon

Power end-to-end data operations for your Lokalise API with Nexla. Our bi-directional Lokalise connector is purpose-built for Lokalise, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Lokalise or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Lokalise workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Lokalise credential, you need to obtain an API token from your Lokalise account settings. The API token is required to authenticate with the Lokalise API.

To obtain your API token, follow these steps:

  1. Sign in to your Lokalise account using your credentials.

  2. Click on your profile icon or avatar in the top-right corner of the Lokalise interface, and select Personal settings or Account settings from the dropdown menu.

  3. In your profile settings, navigate to the API tokens section. This section may be located under Security, Integrations, or directly in the main settings menu, depending on your Lokalise account configuration.

  4. If you don't have an existing API token, click Create token or Generate new token to create a new API token. You may be asked to provide a name or description for the token to help identify it later (e.g., "Nexla Integration").

  5. After generating the API token, copy it immediately. The API token is typically displayed only once for security reasons and may not be accessible again after you navigate away from the page.

  6. Store the API token securely, as you will need it to configure your Nexla credential. The API token provides full access to your Lokalise account data, so treat it as sensitive information.

The API token is sent in the X-Api-Token header for all API requests to the Lokalise API. The API token authenticates your account and grants access to your Lokalise data, including projects, teams, files, languages, tasks, and webhooks. The API token does not expire automatically, but you can regenerate it at any time if needed. For detailed information about API token setup, authentication, and available API endpoints, refer to the Lokalise API documentation and Lokalise API authentication documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API TokenYesYesAPI token generated from Profile settings > API tokens.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Lokalise

LokaliseCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Lokalise uses API Token authentication for all API requests. Enter your Lokalise API token in the API Token field. This is the API token you obtained from your Lokalise profile settings (Profile settings > API tokens) in Prerequisites. The API token is sent in the X-Api-Token header for all API requests to the Lokalise API and authenticates your account and determines what data and operations you can access based on your account permissions.

    Keep your API token secure and do not share it publicly. The API token provides access to your Lokalise account data and should be treated as sensitive information. If your API token is compromised, you should immediately regenerate it in your Lokalise profile settings. The API token does not expire automatically, but you can regenerate it at any time if needed. For detailed information about obtaining and managing API tokens, API authentication, and available endpoints, see the Lokalise API documentation and Lokalise API authentication documentation.

  3. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Lokalise connector tile, then select the credential that will be used to connect to the Lokalise account, and click Next; or, create a new Lokalise credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Lokalise endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Resources

List Resources

  • Select the resource type you want to fetch from the Resource Type pulldown menu. Available resource types include: projects (lists all projects in your user account) and teams (lists all teams in your user account). The default value is "projects". You can also add custom resource types if needed.
  • The endpoint uses GET requests to https://api.lokalise.com/api2/{resource_type} where {resource_type} is the resource type you selected. The endpoint URL is automatically constructed based on your selection.
  • The endpoint does not use pagination (iteration.type: static.url), so it will fetch all resources of the selected type in a single request. The response data path is $.{resource_type}[*], which extracts all resource objects from the response array in the API response.
  • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

This endpoint lists all projects and teams available to the user in your Lokalise account. The endpoint requires API Token authentication, which is handled automatically by your credential configuration. The API token is sent in the X-Api-Token header for all API requests. The resource type determines whether to fetch projects or teams. For detailed information about listing resources, see the Lokalise API documentation.

List Project Resources

List Project Resources

  • Enter the ID of the project in the Project ID field. This is the unique identifier for a specific project in your Lokalise account. You can obtain Project IDs from the "List Resources" endpoint (when selecting "projects" as the resource type) or from your Lokalise account dashboard.
  • Select the project resource type you want to fetch from the Resource Type pulldown menu. Available resource types include: files (lists project files and associated key count), languages (retrieves list of project languages), tasks (lists all tasks in the project), and webhooks (retrieves a list of configured webhooks). The default value is "files". You can also add custom resource types if needed.
  • The endpoint uses GET requests to https://api.lokalise.com/api2/projects/{project_id}/{resource_type} where {project_id} is the Project ID you specified and {resource_type} is the resource type you selected. The endpoint URL is automatically constructed based on your configuration.
  • The endpoint does not use pagination (iteration.type: static.url), so it will fetch all project resources of the selected type in a single request. The response data path is $.{resource_type}[*], which extracts all resource objects from the response array in the API response.
  • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

This endpoint returns a list of project resources by project ID from your Lokalise account. The endpoint requires API Token authentication, which is handled automatically by your credential configuration. The API token is sent in the X-Api-Token header for all API requests. The Project ID identifies which project's resources to retrieve, and the resource type determines which type of resources to fetch (files, languages, tasks, or webhooks). For detailed information about listing project resources, see the Lokalise API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Lokalise data sources can also be manually configured to ingest data from any valid Lokalise API endpoint, including endpoints not covered by the pre-built templates. Lokalise API endpoints typically follow the pattern https://api.lokalise.com/api2/{endpoint_path} and return data in JSON format. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Lokalise data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Lokalise destination, and select the Send to Destination option from the menu. Select the Lokalise connector from the list of available destination connectors, then select the credential that will be used to connect to the Lokalise account, and click Next; or, create a new Lokalise credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Lokalise endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Project Data Transfer

Project Data Transfer

  • Enter the ID of the project in the Project ID field. This is the unique identifier for a specific project in your Lokalise account. You can obtain Project IDs from the "List Resources" endpoint (when selecting "projects" as the resource type) or from your Lokalise account dashboard.
  • Select the type of data transfer from the Type of data transfer pulldown menu. Available transfer types include: upload (queues a localization file for import and returns a 202 or 302 response along with a Queued process object) and download (exports project files as a .zip bundle. Generated bundle will be uploaded to an Amazon S3 bucket, which will be stored there for 12 months available to download). The default value is "upload". You can also add custom transfer types if needed.
  • The endpoint uses POST requests to https://api.lokalise.com/api2/projects/{project_id}/files/{transfer_type} where {project_id} is the Project ID you specified and {transfer_type} is the transfer type you selected. The endpoint URL is automatically constructed based on your configuration.
  • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the data transfer information.
  • Batch mode is disabled by default for this endpoint, which means each record from your Nexset will be sent as a separate API request. This ensures that each data transfer operation is processed individually.
  • This endpoint does not automatically create a data source to track the responses received from the Lokalise API after each call.

The request body must be properly formatted JSON that matches the Lokalise API specification for data transfer operations. The endpoint requires API Token authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. The API token is sent in the X-Api-Token header for all API requests. The Project ID identifies which project to transfer data for, and the transfer type determines whether to upload or download files. For upload operations, the endpoint queues a localization file for import. For download operations, the endpoint exports project files as a .zip bundle that is stored in an Amazon S3 bucket for 12 months. For detailed information about project data transfer, including required fields, field names, and request formats, see the Lokalise API documentation.

Create Project Resources

Create Project Resources

  • Enter the ID of the project in the Project ID field. This is the unique identifier for a specific project in your Lokalise account. You can obtain Project IDs from the "List Resources" endpoint (when selecting "projects" as the resource type) or from your Lokalise account dashboard.
  • Select the project resource type you want to create from the Project Resource Type pulldown menu. Available resource types include: webhooks (use webhooks to receive instant notifications about events happening in Lokalise as HTTP POST requests. Refer to the Lokalise webhooks documentation for more information) and tasks (creates a task in the project). The default value is "webhooks". You can also add custom resource types if needed.
  • The endpoint uses POST requests to https://api.lokalise.com/api2/projects/{project_id}/{resource_type} where {project_id} is the Project ID you specified and {resource_type} is the resource type you selected. The endpoint URL is automatically constructed based on your configuration.
  • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the resource data to create.
  • Batch mode is disabled by default for this endpoint, which means each record from your Nexset will be sent as a separate API request. This ensures that each resource is created individually.
  • This endpoint does not automatically create a data source to track the responses received from the Lokalise API after each call.

The request body must be properly formatted JSON that matches the Lokalise API specification for creating project resources. The endpoint requires API Token authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. The API token is sent in the X-Api-Token header for all API requests. The Project ID identifies which project to create resources in, and the resource type determines which type of resource to create (webhooks or tasks). For webhooks, you can receive instant notifications about events happening in Lokalise as HTTP POST requests. For detailed information about creating project resources, including required fields, field names, and request formats, see the Lokalise API documentation.

Manual configuration

Lokalise destinations can also be manually configured to send data to any valid Lokalise API endpoint. Lokalise API endpoints typically follow the pattern https://api.lokalise.com/api2/{endpoint_path} and use JSON format for request bodies. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Lokalise endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Lokalise endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.