L’API PTC utilizza REST e ti consente di integrare la localizzazione del software nel tuo processo di sviluppo. Gli endpoint API ti consentono di aggiungere e aggiornare file sorgente, recuperare informazioni, gestire le traduzioni e altro ancora.
L’API PTC può essere utilizzata solo in modalità live. Supporta i metodi HTTP standard e restituisce risposte in formato JSON. L’autenticazione è basata su token e specifica per il progetto.
Frammenti di codice
Ruby
Python
PHP
Java
Go
.NET
Node.js
JavaScript (jQuery)
La documentazione utilizza cURL per mostrare come effettuare richieste HTTP all’API PTC, ma puoi passare a diversi esempi di codice.
Autenticazione
Per iniziare:
- Accedi al tuo account PTC. Se non ne hai ancora uno, inizia una prova gratuita.
- Quando configuri il tuo progetto, scegli l’opzione Integrazione API. Dopo aver fornito a PTC un po’ di contesto sul tuo progetto, riceverai un token API.
- Puoi sempre recuperare il tuo token da Impostazioni → Token API PTC nella tua dashboard PTC.
Tutte le richieste all’API PTC richiedono l’autenticazione tramite un token che ti dà accesso a un singolo progetto in PTC.
Includi il token nell’intestazione Authorization di ogni richiesta utilizzando il formato Bearer:
Bearer <AUTHENTICATION_TOKEN>Codici di risposta
L’API PTC utilizza i codici di risposta HTTP standard per indicare il successo o il fallimento di una richiesta.
Riepilogo dei codici di stato HTTP
200
OK
La richiesta ha funzionato come previsto.
401
Non autorizzato
Non è stato fornito alcun token API valido. Controlla se il tuo token è corretto, non è scaduto ed è incluso nell’intestazione Authorization.
Limitazione della frequenza
L’API PTC implementa la limitazione della frequenza per garantire un utilizzo corretto e mantenere la qualità del servizio. I limiti vengono applicati per organizzazione e monitorati tra specifiche operazioni API.
| Tipo di limite | Richieste | Intervallo di tempo | Ambito |
| Operazioni sui file | 10 | 1 minuto | Per organizzazione |
Endpoint interessati
POST /api/v1/source_files– Crea i file sorgentePUT /api/v1/source_files/process– Elabora i file sorgentePOST /api/v1/source_files/bulk– Carica file sorgente in blocco
Quando i limiti di frequenza vengono superati
Se una richiesta supera la frequenza consentita, l’API restituisce:
Status: 429 Too Many Requests
{
"error": "Rate limit exceeded"
}Categorie API disponibili
Carica e gestisci i file sorgente tramite l’API
Utilizza questi endpoint per caricare, sostituire e organizzare i tuoi file sorgente. Questo include:
- Caricare un singolo file o caricare in blocco più file in un archivio ZIP
- Sostituire o aggiornare un file sorgente esistente con nuovi contenuti
- Elencare i file con opzioni di filtro, ordinamento e paginazione
Ottieni i formati di file supportati e le lingue di destinazione tramite l’API
Utilizza questi endpoint per verificare:
- I codici ISO corretti da utilizzare quando si creano lavori di traduzione o si caricano traduzioni
- Quali lingue supporta il tuo progetto
- Tutte le estensioni dei file sorgente che puoi caricare su PTC, insieme a tutti i file di traduzione aggiuntivi che PTC può generare per tali input
Vai a Formati di file disponibili e Lingue di destinazione →
Richiedi e recupera le traduzioni tramite l’API
Utilizza questi endpoint per inviare contenuti per la traduzione, monitorare i suoi progressi e recuperare le traduzioni. Questo include:
- Creare lavori di traduzione per contenuti strutturati in JSON
- Verificare lo stato dei lavori di traduzione
- Recuperare le traduzioni completate
Integra la localizzazione nella tua pipeline CI/CD con l’API PTC
Usa questa guida per automatizzare le traduzioni come parte del tuo processo di build. Questo include:
- Configurazione di PTC con GitHub Actions, GitLab CI/CD o altri sistemi CI/CD utilizzando file di configurazione predefiniti
- Esecuzione delle traduzioni automaticamente e in modo sicuro durante ogni build
