תיעוד ה־API של PTC

ה־API של PTC משתמש ב־REST ומאפשר לכם לשלב לוקליזציה של תוכנה בתהליך הפיתוח שלכם. ה־endpoints של ה־API מאפשרים לכם להוסיף ולעדכן קובצי מקור, לאחזר מידע, לנהל תרגומים ועוד.

ניתן להשתמש ב־API של PTC ב־live mode בלבד. הוא תומך בשיטות HTTP סטנדרטיות ומחזיר תגובות בפורמט JSON. האימות מבוסס על טוקן וספציפי לפרויקט.

קטעי קוד

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);

התיעוד משתמש ב־cURL כדי להראות כיצד לבצע בקשות HTTP ל־API של PTC, אך תוכלו להחליף כרטיסיות כדי לראות את אותה בקשה בשפות אחרות.

אימות

יצירת טוקני API היא תכונת Pro. היא הופכת לזמינה כאשר אתם מפעילים את Pay-As-You-Go.

כדי להתחיל:

• 1

  היכנסו לחשבון ה־PTC שלכם. אם עדיין אין לכם חשבון, התחילו תקופת ניסיון והעלו את הקובץ הראשון שלכם באופן ידני.

• 2

  כדי להעביר פרויקט קיים ל־API integration, היכנסו אל הגדרות → ניהול אסימוני API והוסיפו טוקן גישה. עבור פרויקטים עתידיים, תוכלו לבחור ב־API integration באשף ההגדרה.

כל הבקשות ל־API של PTC דורשות אימות באמצעות טוקן שמעניק לכם גישה לפרויקט יחיד ב־PTC.

כללו את הטוקן ב־header ה־Authorization של כל בקשה באמצעות הפורמט Bearer:

Bearer <AUTHENTICATION_TOKEN>

קודי תגובה

ה־API של PTC משתמש בקודי תגובה סטנדרטיים של HTTP כדי לציין הצלחה או כישלון של בקשה.

קודי סטטוס אימות

הגבלת קצב

ה־API של PTC אוכף מגבלות קצב כדי להבטיח שימוש הוגן ולשמור על איכות השירות. המגבלות חלות לכל ארגון והן מנוטרות בפעולות API מסוימות.

Endpoints מושפעים

• POST /api/v1/source_files – יצירת קובץ המקור
• PUT /api/v1/source_files/process – עיבוד קובץ המקור
• POST /api/v1/source_files/bulk – העלאת קובצי מקור באצווה

כאשר חורגים ממגבלות הקצב

אם בקשה חורגת מהקצב המותר, ה־API מחזיר:

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

קטגוריות API זמינות

1העלאה וניהול של קובצי מקור דרך ה־API

השתמשו ב־endpoints אלה כדי להעלות, להחליף ולארגן את קובצי המקור שלכם. זה כולל:

• העלאת קובץ בודד או העלאה באצווה של מספר קבצים בקובץ ZIP
• החלפה או עדכון של קובץ מקור קיים בתוכן חדש
• הצגת רשימת קבצים עם אפשרויות סינון, מיון ועימוד

מעבר אל העלאה וניהול של קובצי מקור →

2קבלת פורמטים נתמכים של קבצים ושפות יעד דרך ה־API

השתמשו ב־endpoints אלה כדי לבדוק:

• קודי ה־ISO הנכונים לשימוש בעת יצירת משימות תרגום או העלאת תרגומים
• באילו שפות הפרויקט שלכם תומך
• כל סיומות קובצי המקור שניתן להעלות ל־PTC, יחד עם קבצי תרגום נוספים ש־PTC יכולה ליצור עבור קלטים אלה

מעבר אל פורמטים זמינים של קבצים ושפות יעד →

3בקשה ואחזור של תרגומים דרך ה־API

השתמשו ב־endpoints אלה כדי להגיש תוכן לתרגום, לעקוב אחר ההתקדמות שלו ולאחזר תרגומים. זה כולל:

• יצירת משימות תרגום עבור תוכן מובנה ב־JSON
• בדיקת הסטטוס של משימות תרגום
• אחזור תרגומים שהושלמו

מעבר אל בקשה ואחזור של תרגומים →

4שילוב לוקליזציה בצינור ה־CI/CD שלכם בעזרת ה־API של PTC

השתמשו במדריך זה כדי להפוך תרגומים לאוטומטיים כחלק מתהליך ה־build שלכם. זה כולל:

• הגדרת PTC עם GitHub Actions, GitLab CI/CD, או מערכות CI/CD אחרות באמצעות קובצי תצורה מוכנים מראש
• הרצת תרגומים באופן אוטומטי ומאובטח במהלך כל build

מעבר אל אינטגרציית CI/CD →