PTC API-Referenz

Die PTC API nutzt REST und ermöglicht es Ihnen, die Software-Lokalisierung in Ihren Entwicklungsprozess zu integrieren. Über die API-Endpunkte können Sie Quelldateien hinzufügen und aktualisieren, Informationen abrufen, Übersetzungen verwalten und vieles mehr.

Die PTC API kann nur im Live-Modus verwendet werden. Sie unterstützt Standard-HTTP-Methoden und gibt Antworten im JSON-Format zurück. Die Authentifizierung erfolgt tokenbasiert und projektspezifisch.

Code-Snippets

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/supported_extensions" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

require 'net/http'
require 'uri'

uri = URI('https://app.ptc.wpml.org/api/v1/source_files/supported_extensions')

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get('https://app.ptc.wpml.org/api/v1/source_files/supported_extensions', headers=headers)
print(response.json())

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://app.ptc.wpml.org/api/v1/source_files/supported_extensions',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_TOKEN'
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

print_r(json_decode($response, true));
?>

import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://app.ptc.wpml.org/api/v1/source_files/supported_extensions")
    .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
    .build();

Response response = client.newCall(request).execute();
System.out.println(response.body().string());

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://app.ptc.wpml.org/api/v1/source_files/supported_extensions", nil)

    req.Header.Add("Authorization", "Bearer YOUR_API_TOKEN")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

using System;
using System.Net.Http;
using System.Threading.Tasks;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "YOUR_API_TOKEN");

var response = await client.GetAsync("https://app.ptc.wpml.org/api/v1/source_files/supported_extensions");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);

const axios = require('axios');

const response = await axios.get('https://app.ptc.wpml.org/api/v1/source_files/supported_extensions', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

console.log(response.data);

Die Dokumentation verwendet cURL, um zu zeigen, wie HTTP-Anfragen an die PTC API gestellt werden. Sie können jedoch die Tabs wechseln, um dieselbe Anfrage in anderen Sprachen zu sehen.

Authentifizierung

Das Erstellen von API-Token ist eine Pro-Funktion. Sie wird verfügbar, sobald Sie Pay-As-You-Go aktivieren.

So fangen Sie an:

• 1

  Melden Sie sich in Ihrem PTC-Konto an. Falls Sie noch keines haben, starten Sie eine kostenlose Testphase und laden Sie Ihre erste Datei manuell hoch.

• 2

  Um ein bestehendes Projekt auf API-Integration umzustellen, gehen Sie zu Settings → Manage API Tokens und fügen Sie einen API-Token hinzu. Bei nachfolgenden Projekten können Sie die API-Integration direkt im Setup-Assistenten auswählen.

Alle Anfragen an die PTC API erfordern eine Authentifizierung über einen Token, der Ihnen Zugriff auf ein einzelnes Projekt in PTC gewährt.

Geben Sie den Token im Authorization-Header jeder Anfrage im Bearer-Format an:

Bearer <AUTHENTICATION_TOKEN>

Antwort-Codes

Die PTC API verwendet Standard-HTTP-Antwort-Codes, um den Erfolg oder das Scheitern einer Anfrage anzuzeigen.

Authentifizierungs-Status-Codes

Rate Limiting

Die PTC API implementiert Rate Limiting, um eine faire Nutzung zu gewährleisten und die Servicequalität aufrechtzuerhalten. Die Limits gelten pro Organisation und werden über spezifische API-Operationen hinweg verfolgt.

Betroffene Endpunkte

• POST /api/v1/source_files – Quelldateien erstellen
• PUT /api/v1/source_files/process – Quelldateien verarbeiten
• POST /api/v1/source_files/bulk – Quelldateien per Bulk-Upload hochladen

Wenn Rate-Limits überschritten werden

Wenn eine Anfrage die zulässige Rate überschreitet, gibt die API Folgendes zurück:

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

Verfügbare API-Kategorien

1Quelldateien über die API hochladen und verwalten

Nutzen Sie diese Endpunkte, um Ihre Quelldateien hochzuladen, zu ersetzen und zu organisieren. Dies umfasst:

• Hochladen einer einzelnen Datei oder Bulk-Upload mehrerer Dateien in einem ZIP-Archiv
• Ersetzen oder Aktualisieren einer bestehenden Quelldatei mit neuen Inhalten
• Auflisten von Dateien mit Optionen für Filterung, Sortierung und Paginierung

Zum Hochladen und Verwalten von Quelldateien →

2Unterstützte Dateiformate und Zielsprachen über die API abrufen

Nutzen Sie diese Endpunkte zur Überprüfung von:

• Den korrekten ISO-Codes, die beim Erstellen von Übersetzungsaufträgen oder beim Hochladen von Übersetzungen zu verwenden sind
• Welche Sprachen Ihr Projekt unterstützt
• Allen Quelldatei-Erweiterungen, die Sie in PTC hochladen können, zusammen mit zusätzlichen Übersetzungsdateien, die PTC für diese Eingaben generieren kann

Zu verfügbaren Dateiformaten und Zielsprachen →

3Übersetzungen über die API anfordern und abrufen

Nutzen Sie diese Endpunkte, um Inhalte zur Übersetzung einzureichen, den Fortschritt zu verfolgen und Übersetzungen abzurufen. Dies umfasst:

• Erstellen von Übersetzungsaufträgen für JSON-strukturierte Inhalte
• Prüfen des Status von Übersetzungsaufträgen
• Abrufen abgeschlossener Übersetzungen

Zum Anfordern und Abrufen von Übersetzungen →

4Lokalisierung mit der PTC API in Ihre CI/CD-Pipeline integrieren

Nutzen Sie diesen Leitfaden, um Übersetzungen als Teil Ihres Build-Prozesses zu automatisieren. Dies umfasst:

• Einrichten von PTC mit GitHub Actions, GitLab CI/CD oder anderen CI/CD-Systemen unter Verwendung vorgefertigter Konfigurationsdateien
• Automatisches und sicheres Ausführen von Übersetzungen bei jedem Build

Zur CI/CD-Integration →