PTC-API-Referenz

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

Die PTC-API kann nur im Live-Modus verwendet werden. Sie unterstützt Standard-HTTP-Methoden und gibt JSON-formatierte Antworten zurück. Die Authentifizierung ist 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-Tokens ist eine Pro-Funktion. Sie wird verfügbar, wenn Sie Pay-As-You-Go aktivieren.

Erste Schritte:

• 1

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

• 2

  Um ein bestehendes Projekt auf die API-Integration umzustellen, gehen Sie zu Einstellungen → API-Tokens verwalten und fügen Sie ein Zugriffstoken hinzu. Für nachfolgende Projekte können Sie die API-Integration im Einrichtungsassistenten auswählen.

Alle Anfragen an die PTC-API erfordern eine Authentifizierung mithilfe eines Tokens, das Ihnen Zugriff auf ein einzelnes Projekt in PTC gewährt.

Fügen Sie das Token im Authorization-Header jeder Anfrage im Format Bearer ein:

Bearer <AUTHENTICATION_TOKEN>

Antwortcodes

Die PTC-API verwendet Standard-HTTP-Antwortcodes, um den Erfolg oder Fehlschlag einer Anfrage anzuzeigen.

Authentifizierungs-Statuscodes

Rate Limiting

Die PTC-API implementiert Rate Limiting, um eine faire Nutzung sicherzustellen und die Servicequalität aufrechtzuerhalten. Ratenbegrenzungen werden pro Organisation angewendet und über bestimmte API-Operationen hinweg verfolgt.

Betroffene Endpunkte

• POST /api/v1/source_files – Quelldatei erstellen
• PUT /api/v1/source_files/process – Quelldatei verarbeiten
• POST /api/v1/source_files/bulk – Quelldateien im Stapel hochladen

Wenn Ratenbegrenzungen ü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

Verwenden 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 Filter-, Sortier- und Paginierungsoptionen

Zu Quelldateien hochladen und verwalten →

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

Verwenden Sie diese Endpunkte, um Folgendes zu prüfen:

• Die korrekten ISO-Codes für die Erstellung von Übersetzungsjobs oder das Hochladen von Übersetzungen
• Welche Sprachen Ihr Projekt unterstützt
• Alle Quelldateiendungen, die Sie in PTC hochladen können, sowie alle zusätzlichen Übersetzungsdateien, die PTC für diese Eingaben generieren kann

Zu Verfügbare Dateiformate und Zielsprachen →

3Übersetzungen über die API anfordern und abrufen

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

• Erstellen von Übersetzungsjobs für JSON-strukturierte Inhalte
• Überprüfen des Status von Übersetzungsjobs
• Abrufen abgeschlossener Übersetzungen

Zu Übersetzungen anfordern und abrufen →

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

Verwenden Sie diese Anleitung, 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 mithilfe vorgefertigter Konfigurationsdateien
• Automatisches und sicheres Ausführen von Übersetzungen bei jedem Build

Zur CI/CD-Integration →