Complete Your First Software Localization Workflow

• An approved Stepes Software Localization API key
• Access to the assigned sandbox or production environment
• cURL, Postman, Node.js, Python, or another server-side development environment
• A supported structured software resource file
• A defined source locale and at least one target locale
• Permission to submit the selected software content
• A secure secrets-management process
• A stable application or project reference for reconciling API activity

Prepare an Internationalized Resource

The API manages localization content; it does not replace software internationalization. Externalize user-facing strings, use stable keys, document variables and character limits, and confirm that your application can load locale-specific resources correctly.

A first implementation can begin with one workspace, one project, one branch, one resource file, and one target locale. Add repository mappings, parallel release branches, and broader workflow controls as your localization program grows.

export STEPES_BASE_URL="https://api.sandbox.stepes.com/v2"
export STEPES_API_KEY="YOUR_STEPES_API_KEY"

$env:STEPES_BASE_URL = "https://api.sandbox.stepes.com/v2"
$env:STEPES_API_KEY = "YOUR_STEPES_API_KEY"

Send the assigned API key in the Authorization header using the bearer scheme. Additional headers may apply for workspace context, idempotency, tracing, or operation-specific controls.

curl --request GET \
  --url "$STEPES_BASE_URL/workspaces" \
  --header "Authorization: Bearer $STEPES_API_KEY" \
  --header "Accept: application/json"

const response = await fetch(
  `${process.env.STEPES_BASE_URL}/workspaces`,
  {
    headers: {
      Authorization: `Bearer ${process.env.STEPES_API_KEY}`,
      Accept: "application/json"
    }
  }
);

if (!response.ok) {
  throw new Error(`Authentication check failed: ${response.status}`);
}

console.log(await response.json());

import os
import requests

response = requests.get(
    f'{os.environ["STEPES_BASE_URL"]}/workspaces',
    headers={
        "Authorization": f'Bearer {os.environ["STEPES_API_KEY"]}',
        "Accept": "application/json",
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())

Confirm the Returned Context

• Organization and workspace
• Environment and API version
• Integration identity
• Assigned permissions
• Available software-localization capabilities

Authentication Troubleshooting

Confirm the API key, bearer header, base URL, and target environment. Use the returned Stepes-Request-Id when troubleshooting authentication or permission failures, and rotate any key that may have been exposed.

{
  "name": "Account Security",
  "clientReference": "account-security-localization",
  "sourceLocale": "en-US",
  "targetLocales": ["fr-FR"],
  "defaultBranch": "main",
  "resourceFormat": "json",
  "workflow": {
    "mode": "ai_translation_with_human_review",
    "useTranslationMemory": true,
    "applyTerminology": true,
    "requireQualityValidation": true,
    "requireApprovalBeforeBuild": true
  }
}

Choose the Right Workflow

An internal diagnostic message, customer-facing navigation label, payment confirmation, legal notice, and medical warning carry different levels of visibility and risk. Configure translation and review based on content type, technical complexity, target market, regulatory importance, and release requirements.

{
  "account.security.reset_password_button": "Reset password",
  "account.security.password_requirements": "Use at least {minCharacters} characters.",
  "account.security.reset_password_success": "Password reset for {username}.",
  "account.security.two_factor_auth": "Two-factor authentication"
}

account-security.json

+ password_requirements
  New key · localization required

~ reset_password_success
  Source updated · review required

= two_factor_auth
  Unchanged · approved translation retained

− legacy_security_question
  Removed · archived according to project policy

Validate the Imported Resource

Review file format, encoding, duplicate keys, missing values, unsupported syntax, placeholders, plurals, locale compatibility, character limits, and resource integrity before localization begins.

{
  "branch": "main",
  "resources": ["account-security.json"],
  "targetLocales": ["fr-FR"],
  "selection": {
    "mode": "changed_strings"
  },
  "workflow": {
    "mode": "ai_translation_with_human_review"
  },
  "delivery": {
    "requireApproval": true,
    "requireQualityValidation": true
  }
}

{
  "id": "evt_01JEXAMPLE",
  "type": "build.generated",
  "createdAt": "2026-07-27T18:35:10Z",
  "data": {
    "projectId": "slp_01JEXAMPLE",
    "branch": "main",
    "buildId": "slb_01JEXAMPLE",
    "locales": ["fr-FR"],
    "status": "ready"
  }
}

What Happens After Submission

1. 01Reuse approved translation-memory matches.
2. 02Apply product terminology and locale requirements.
3. 03Generate AI translations for eligible content.
4. 04Route selected strings to professional linguists and reviewers.
5. 05Validate placeholders, markup, plurals, terminology, length, and locale completeness.
6. 06Mark approved translations as eligible for a localized build.

Monitor Status Responsibly

Polling can support an initial sandbox integration. Increase the interval between checks, respect rate limits, stop at documented terminal states, and handle locale-specific or partial completion without restarting successful work.

Production integrations should use signed webhooks for meaningful workflow events. Verify signatures against the unchanged raw request body, process every event idempotently, and expect duplicate, delayed, or out-of-order delivery.

{
  "account.security.reset_password_button": "Réinitialiser le mot de passe",
  "account.security.password_requirements": "Utilisez au moins {minCharacters} caractères.",
  "account.security.reset_password_success": "Le mot de passe de {username} a été réinitialisé.",
  "account.security.two_factor_auth": "Authentification à deux facteurs"
}

The output preserves source keys, runtime placeholders, resource syntax, locale mapping, and approved terminology. Before moving it into development, confirm the project, branch, source revision, resource format, approvals, quality results, and file integrity.

Return the Resource to Development

A direct integration can place the completed file in the expected locale directory. A connected workflow can commit the resource to a branch, create a pull request, trigger resource linting, build the localized application, and begin visual or functional localization testing.