PTC API Reference

The PTC API uses REST and allows you to integrate software localization into your development process. The API endpoints let you add and update source files, retrieve information, manage translations, and more.

The PTC API can be used in live mode only. It supports standard HTTP methods and returns JSON-formatted responses. Authentication is token-based and project-specific.

Code Snippets

Ruby

Python

PHP

Java

Go

.NET

Node.js

JavaScript (jQuery)

The documentation uses cURL to show how to make HTTP requests to the PTC API, but you can switch to see different examples in code.

Authentication

To get started:

1. Log into your PTC account. If you don’t have one yet, start a free trial.
2. When setting up your project, choose the API integration option. After providing PTC with some context about your project, you’ll receive an API token.
3. You can always retrieve your token from Settings → PTC API Tokens in your PTC dashboard.

All requests to the PTC API require authentication using a token that gives you access to a single project in PTC.

Include the token in the Authorization header of every request using the Bearer format:

Bearer <AUTHENTICATION_TOKEN>

Bearer <AUTHENTICATION_TOKEN>

Response Codes

The PTC API uses standard HTTP response codes to indicate the success or failure of a request.

HTTP Status Code Summary

Rate Limiting

The PTC API implements rate limiting to ensure fair usage and maintain service quality. Limits are applied per organization and tracked across specific API operations.

Affected Endpoints

• POST /api/v1/source_files – Create the source files
• PUT /api/v1/source_files/process – Process the source files
• POST /api/v1/source_files/bulk – Upload source files in bulk

When Rate Limits Are Exceeded

If a request exceeds the allowed rate, the API returns:

Status: 429 Too Many Requests
{
  "error": "Rate limit exceeded"
}

Status: 429 Too Many Requests
{
  "error": "Rate limit exceeded"
}

Available API Categories