Skip to main content

Lokalise Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Lokalise source.
lokalise.png

Lokalise

Follow the instructions below to create a new data flow that ingests data from a Lokalise source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Lokalise connector tile from the list of available 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.

  3. In Nexla, Lokalise data sources can be created using pre-built endpoint templates, which expedite source setup for common Lokalise endpoints. Each template is designed specifically for the corresponding Lokalise endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Lokalise sources can also be configured manually, allowing you to ingest data from Lokalise endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Lokalise endpoints. Each template is designed specifically for the corresponding Lokalise endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    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.

Configure Manually​

Lokalise data sources can be manually configured to ingest data from any valid Lokalise API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Lokalise sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Lokalise API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Lokalise API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Lokalise API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Lokalise API endpoints typically follow the pattern https://api.lokalise.com/api2/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. 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. For detailed information about Lokalise API endpoints, authentication, and available APIs, see the Lokalise API documentation.