API Documentation

<script src="https://nexling.app/nl.js"
        data-project="YOUR-PROJECT-ID"></script>

<script src="https://nexling.app/nl.js"
        data-project="YOUR-PROJECT-ID"
        data-default-language="de-CH"
        data-switcher="true"
        data-position="bottom-right"></script>

<!-- Text content -->
<h1 data-nl="page_title">Willkommen</h1>

<!-- Attributes -->
<input data-nl-placeholder="search_hint" placeholder="Suchen…">
<img  data-nl-alt="logo_alt" alt="Firmenlogo">
<a    data-nl-title="home_tip" title="Zur Startseite">Home</a>
<button data-nl-label="close_btn" aria-label="Schliessen">×</button>

<!-- Raw HTML (use only with trusted content) -->
<div data-nl-html="rich_intro"><b>Hallo</b> Welt</div>

<!-- Never translate this subtree -->
<pre data-nl-skip>const x = "Speichern";</pre>

// Switching
await Nexling.setLanguage('fr-CH');
Nexling.getLanguage();        // → 'fr-CH'
Nexling.getLanguages();       // → [{ code, name, isSource }, …]

// Keyed lookup
Nexling.t('save_button');              // → 'Speichern'
Nexling.t('greeting', { name: 'Ana' }); // → 'Hallo, Ana!'

// Re-applying
Nexling.refresh();          // re-apply current language, no refetch
Nexling.init();             // re-initialise (SPA route changes)
Nexling.restoreOriginal();  // put the original text back
Nexling.restoreToSource('de-CH');

// Events
Nexling.on('ready',       () => console.log('translated'));
Nexling.on('langChanged', code => console.log('now', code));
Nexling.on('error',       err => console.warn(err));
Nexling.off('ready', handler);

// React Router / Vue Router — re-scan after each navigation
router.afterEach(() => Nexling.init());

curl https://nexling.app/MyApi/languages/YOUR-PROJECT-ID

[
  { "code": "de-CH", "name": "German (Switzerland)", "isSource": true  },
  { "code": "fr-CH", "name": "French (Switzerland)",  "isSource": false },
  { "code": "it-CH", "name": "Italian (Switzerland)", "isSource": false }
]

curl https://nexling.app/MyApi/translates/YOUR-PROJECT-ID/fr-CH

{
  "save_button": "Enregistrer",
  "learn_more":  "En savoir plus"
}

curl https://nexling.app/MyApi/map/YOUR-PROJECT-ID/fr-CH

{
  "byKey": {
    "learn_more": "En savoir plus"
  },
  "byText": {
    "Mehr erfahren": { "value": "En savoir plus", "context": "a" }
  }
}

curl -H "X-Api-Key: nxl_your_key_here" \
     https://nexling.app/api/export/json/fr-CH

curl -H "X-Api-Key: nxl_your_key_here" \
     https://nexling.app/api/export/languages

# Pull the latest translations during a build
for LANG in de-CH fr-CH it-CH; do
  curl -sf -H "X-Api-Key: $NEXLING_API_KEY" \
       "https://nexling.app/api/export/json/$LANG" \
       -o "locales/$LANG.json"
done

POST /your-endpoint
X-Nexling-Event: translation.completed
X-Nexling-Signature: sha256=9f86d081884c7d65…
User-Agent: Nexling-Webhooks/1.0

{
  "event": "translation.completed",
  "projectId": "YOUR-PROJECT-ID",
  "timestamp": "2026-09-07T14:22:31Z",
  "data": {
    "languageCode": "fr-CH",
    "translatedCount": 128,
    "totalTerms": 130,
    "engine": "claude-haiku",
    "coveragePercent": 98.5
  }
}

const crypto = require('crypto');

function isFromNexling(rawBody, header, secret) {
  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(rawBody)          // the raw body, before JSON.parse
    .digest('hex');

  // Constant-time compare — never use ===
  return crypto.timingSafeEqual(
    Buffer.from(expected), Buffer.from(header)
  );
}

using var hmac = new HMACSHA256(Encoding.UTF8.GetBytes(secret));
var expected = "sha256=" + Convert.ToHexString(
    hmac.ComputeHash(Encoding.UTF8.GetBytes(rawBody))).ToLowerInvariant();

var ok = CryptographicOperations.FixedTimeEquals(
    Encoding.UTF8.GetBytes(expected),
    Encoding.UTF8.GetBytes(signatureHeader));

HTTP/1.1 429 Too Many Requests
Retry-After: 60

{ "error": "Rate limit exceeded", "retryAfter": 60 }