Skip to main content

Lokalise Destination

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 sends data to a Lokalise location.
lokalise.png

Lokalise

Create a Lokalise Destination​

  1. Click the + icon on the Nexset that will be sent to the Lokalise destination, and select the Send to Destination option from the menu.

  2. 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.

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

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

Configure Using a Template​

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

  • To configure this destination using a template, 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.

Configure Manually​

Lokalise destinations can be manually configured to send data to 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 destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Content Format​

  1. Select the format in which the Nexset data will be sent to the Lokalise API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Lokalise API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Lokalise API endpoint to which you want to send the Nexset data in the 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.