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 mit einem Token, das Ihnen Zugriff auf ein einzelnes Projekt in PTC gewährt.

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

Bearer <AUTHENTIFIZIERUNGS_TOKEN

Bearer <AUTHENTICATION_TOKEN>

Antwortcodes

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

Zusammenfassung der HTTP-Statuscodes

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.

Betroffene Endpunkte

• POST /api/v1/source_files – Quelldateien erstellen
• PUT /api/v1/source_files/process – Quelldateien verarbeiten
• POST /api/v1/source_files/bulk – Quelldateien in großen Mengen hochladen

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"
}

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

Verfügbare API-Kategorien