Smartling API SDK for Python

3.1.9 · active · verified Sun Apr 12

The Smartling API SDK for Python simplifies interaction with Smartling's cloud-based translation services APIs from Python applications. It provides a convenient, idiomatic Python interface to automate translation workflows, including file uploads, downloads, job management, and string operations. The current version is 3.1.9, and the library receives regular updates to support new API features and improvements.

Warnings

breaking Smartling API breaking changes are released in new API versions. These can include removing/renaming endpoints or parameters, changing data types, making optional parameters required, or altering authentication requirements. Always refer to the official API reference for the specific version you are using.
Fix: Monitor Smartling's API documentation and release notes for new API versions and associated breaking changes. Upgrade the SDK and update your code accordingly when migrating to a new API version.
gotcha While Smartling's underlying API uses OAuth2 with expiring access tokens, the Python SDK automatically handles authentication and token refreshing. You provide your `userIdentifier` and `userSecret` once during client initialization, and the SDK manages the access token lifecycle.
Fix: Trust the SDK to manage authentication tokens; avoid attempting manual token refresh unless you are directly interacting with the REST API without the SDK.
gotcha When importing translations for files that use HTML processing, a specific sequence of operations is required to prevent string fragmentation and loss of keys. Upload the file without HTML processing, import translations, then re-upload with HTML processing enabled.
Fix: For key-based resource files with pre-translated strings that also require HTML processing, upload the source file first *without* HTML processing. Import the translations, then re-upload the source file *with* HTML processing enabled. Smartling may use SmartMatch for existing translations, but some strings might need re-translation.
gotcha Importing Translation Memory eXchange (TMX) files into Smartling does not preserve plural information. Once imported, all plural form details for those translations are lost.
Fix: Be aware of this limitation when migrating TMX files from other systems. If plural information is critical, plan to manage it outside the TMX import process or re-enter it within Smartling after import.

Install

pip install SmartlingApiSDK Install with pip

Imports

FilesApi

from smartlingApiSdk.api import FilesApi

JobsApi
```
from smartlingApiSdk.api import JobsApi
```

StringsApi

from smartlingApiSdk.api import StringsApi

AccountProjectsApi

from smartlingApiSdk.api import AccountProjectsApi

ContextApi

from smartlingApiSdk.api import ContextApi

EstimatesApi

from smartlingApiSdk.api import EstimatesApi

JobBatchesV2Api

from smartlingApiSdk.api import JobBatchesV2Api

TagsApi
```
from smartlingApiSdk.api import TagsApi
```
Credentials
```
from smartlingApiSdk.Credentials import Credentials
```
Used for loading credentials from a file, though environment variables are often preferred.

Quickstart

This quickstart demonstrates how to initialize the `ProjectsApi` client using Smartling API credentials (user identifier, user secret, and account ID) retrieved from environment variables. It then attempts to list the first three projects associated with the account, verifying successful connectivity and basic API interaction. Ensure you set the `SMARTLING_USER_IDENTIFIER`, `SMARTLING_USER_SECRET`, and `SMARTLING_ACCOUNT_ID` environment variables before running.

import os
from smartlingApiSdk.api import ProjectsApi

USER_IDENTIFIER = os.environ.get('SMARTLING_USER_IDENTIFIER', '')
USER_SECRET = os.environ.get('SMARTLING_USER_SECRET', '')
ACCOUNT_ID = os.environ.get('SMARTLING_ACCOUNT_ID', '')

if not all([USER_IDENTIFIER, USER_SECRET, ACCOUNT_ID]):
    print("Please set SMARTLING_USER_IDENTIFIER, SMARTLING_USER_SECRET, and SMARTLING_ACCOUNT_ID environment variables.")
else:
    try:
        projects_api = ProjectsApi(USER_IDENTIFIER, USER_SECRET, ACCOUNT_ID)
        # List projects in the account
        projects_response = projects_api.listProjects()
        print("Successfully connected to Smartling and listed projects.")
        print(f"First 3 projects: {projects_response.data.items[:3]}")
    except Exception as e:
        print(f"An error occurred: {e}")

view raw JSON →