PTC API-Referenz

Die PTC API verwendet REST und ermöglicht es Ihnen, Softwarelokalisierung in Ihren Entwicklungsprozess zu integrieren. Die API-Endpunkte ermöglichen es Ihnen, Quelldateien hinzuzufügen und zu aktualisieren, Informationen abzurufen, Übersetzungen zu verwalten und vieles 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

Ruby

Python

PHP

Java

Go

.NET

Node.js

JavaScript (jQuery)

Die Dokumentation verwendet cURL, um zu zeigen, wie HTTP-Anfragen an die PTC API gestellt werden, aber Sie können wechseln, um verschiedene Beispiele im Code zu sehen.

Authentifizierung

So fangen Sie an:

  1. Melden Sie sich bei Ihrem PTC-Konto an. Wenn Sie noch keines haben, starten Sie eine kostenlose Testphase.
  2. Bei der Einrichtung Ihres Projekts wählen Sie die Option API-Integration. Nachdem Sie PTC etwas Kontext zu Ihrem Projekt gegeben haben, erhalten Sie einen API-Token.
  3. Sie können Ihren Token jederzeit unter Einstellungen → PTC API-Tokens in Ihrem PTC-Dashboard abrufen.

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

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

Bearer <AUTHENTICATION_TOKEN>

Antwortcodes

Die PTC API verwendet standardmäßige HTTP-Antwortcodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen.

Zusammenfassung der HTTP-Statuscodes

200

OK

Die Anfrage wurde wie erwartet ausgeführt.


401

Nicht autorisiert

Es wurde kein gültiger API-Token bereitgestellt. Überprüfen Sie, ob Ihr Token korrekt ist, nicht abgelaufen ist und im Authorization Header enthalten ist.

Ratenbegrenzung

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

Limit-TypAnfragenZeitrahmenGeltungsbereich
Dateioperationen101 MinutePro Organisation

Betroffene Endpunkte

Wenn Ratenbegrenzungen überschritten werden

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

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

Verfügbare API-Kategorien

Quelldateien über die API hochladen und verwalten

Verwenden Sie diese Endpunkte, um Ihre Quelldateien hochzuladen, zu ersetzen und zu organisieren. Dies beinhaltet:

  • Hochladen einer einzelnen Datei oder Massen-Upload mehrerer Dateien in einem ZIP-Archiv
  • Ersetzen oder Aktualisieren einer bestehenden Quelldatei mit neuem Inhalt
  • Auflisten von Dateien mit Filter-, Sortier- und Paginierungsoptionen

Gehen Sie zu Quellendateien hochladen und verwalten →

Unterstützte Dateiformate und Zielsprachen über die API abrufen

Verwenden Sie diese Endpunkte, um zu überprüfen:

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

Gehen Sie zu verfügbare Dateiformate und Zielsprachen →

Übersetzungen über die API anfordern und abrufen

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

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

Gehen Sie zu Übersetzungen anfordern und abrufen →

Integrieren Sie die Lokalisierung mit der PTC-API in Ihre CI/CD-Pipeline.

Nutzen Sie diese Anleitung, um Übersetzungen als Teil Ihres Build-Prozesses zu automatisieren. Dies beinhaltet:

  • Einrichtung 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 gehen →

Nach oben scrollen