Quick Start

Obtain Credentials

Open the Loxily console, choose Open Platform from the left menu, and grab the following from the top info card:

• App Key — Project identifier used as request origin (click to copy)
• App Secret — Used for request signing. Keep it secure and never share (masked by default, click the eye icon to reveal)

For first-time use click "Generate App Secret"; if it leaks, regenerate it on the same card (the old Secret stops working immediately).

Understand the Signing Mechanism

All Open Platform API requests are authenticated entirely via HTTP headers (X-Loxily-AppKey / X-Loxily-Timestamp / X-Loxily-Sign). The request body stays a plain business JSON.

See Signing Algorithm for the exact formula, examples and code snippets; see Common Parameters for the common request headers, common response fields, and error code reference.

Recommended Integration Path

1. Call Query Project Languages first — confirm which target languages are enabled for the project bound to this AppKey
2. Call Create Translation Task — get task_id and trace_id
3. Listen for callbacks — the task pushes events to your configured callback_url after each workflow step (term_scan.completed → TRANSLATE sub-steps → task.completed / task.failed / smart_optimize.completed)
4. If auto_apply_terms=false was set at create time — after receiving term_scan.completed, optionally query / update / delete the scanned terms, then call Confirm Terms and Continue to kick off translation

The "API Playground" tab on the Open Platform page provides an online debugger. The "Call Logs" tab lets you look up any request by trace_id to see the full Request / Response / Callback timeline.