PTC

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

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

ה־API הזה מקבל תוכן מובנה ב־JSON, ושומר על המבנה והמפתחות המקוריים. הוא מתרגם רק ערכי טקסט, ומשאיר מספרים, ערכים בוליאניים, ערכי null וערכים אחרים שאינם טקסט ללא שינוי.

Create Content Translations

יוצר משימת תרגום חדשה מנתונים מובנים ב־JSON.

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

הוא שימושי במיוחד עבור:

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

ליישום מלא של תהליך זה ב־Rails, ראו תרגום תוכן דינמי ב־Rails באמצעות ה־API של PTC.

בקשת HTTP

POST https://app.ptc.wpml.org/api/v1/content_translation

פרמטרים

פרמטר סוג חובה תיאור
data אובייקט כן הנתונים המובנים ב־JSON לתרגום. הם יכולים לכלול אובייקטים מקוננים, מערכים וערכי מחרוזות.
name מחרוזת לא שם קריא לאדם עבור משימת התרגום. אם יושמט, ייווצר שם באופן אוטומטי.
callback_url מחרוזת לא כתובת ה־URL שמקבלת התראות webhook כאשר התרגום מסתיים.
target_languages מערך[מחרוזת] לא מערך קודי ה־ISO של שפות היעד. אם יושמט, ייווצרו תרגומים לכל השפות המוגדרות בפרויקט. למידע נוסף, ראו API שפות יעד זמינות.

דוגמה לגוף הבקשה

{
  "data": {
    "app": {
      "title": "My Application",
      "navigation": {
        "home": "Home",
        "about": "About Us",
        "contact": "Contact"
      },
      "buttons": {
        "save": "Save",
        "cancel": "Cancel",
        "submit": "Submit"
      },
      "messages": {
        "welcome": "Welcome to our platform",
        "error": "An error occurred"
      }
    },
    "version": "1.0.0",
    "settings": {
      "theme": "dark",
      "notifications": true
    }
  },
  "name": "App UI Translations",
  "callback_url": "https://your-app.com/webhooks/translation-complete",
  "target_languages": ["es", "fr", "de"]
}

תשובות

תשובת הצלחה

201 Createdapplication/json
{
  "id": 123,
  "name": "App UI Translations",
  "status": "queued",
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:30:00.000Z"
}

סכמת התשובה

שדה סוג תיאור
id מספר המזהה הייחודי של משימת תרגום התוכן.
name מחרוזת שם המשימה (נוצר אוטומטית אם לא סופק).
status מחרוזת הסטטוס הנוכחי של המשימה (queued, processing, completed).
created_at מחרוזת חותמת הזמן בפורמט ISO 8601 המציינת מתי המשימה נוצרה.
updated_at מחרוזת חותמת הזמן בפורמט ISO 8601 המציינת מתי המשימה עודכנה לאחרונה.

תשובות שגיאה

נתוני JSON לא תקינים
422 Unprocessable Entity
{
  "errors": {
    "data": ["Data must be a valid JSON object"]
  }
}
שפות יעד לא תקינות
422 Unprocessable Entity
{
  "errors": {
    "target_languages": ["Language codes [zh, xx] are not configured for this project"]
  }
}
לא מורשה
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
גישה נדחתה
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

עיבוד נתוני JSON

בעבודה עם נתונים מובנים ב־JSON, PTC מעבדת את הנתונים באופן הבא:

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

דוגמה להמרת נתונים

קלט:

{
  "user": {
    "name": "Welcome User",
    "settings": {
      "theme": "Choose Theme",
      "count": 5,
      "enabled": true
    }
  }
}

תוצאת העיבוד:

  • user.name: “Welcome User” ← מתורגם
  • user.settings.theme: “Choose Theme” ← מתורגם
  • user.settings.count: 5 ← נשאר ללא שינוי
  • user.settings.enabled: true ← נשאר ללא שינוי

תהליך התרגום

  1. אימות: מבנה ה־JSON ושפות היעד נבדקים
  2. הכנת קובץ המקור: ה־JSON מומר לפורמט מקור פנימי
  3. שימוש חוזר במחרוזות דרך זיכרון תרגומי: כל המחרוזות הניתנות לתרגום מחולצות ונשמרות בזיכרון התרגומי של הפרויקט שלכם, כך שניתן יהיה לעשות שימוש חוזר בתרגומים קודמים
  4. הכנסת משימות לתור: משימה נכנסת לתור עבור כל שפת יעד
  5. עיבוד: תרגום אוטומטי רץ על המחרוזות שחולצו
  6. Callback (אופציונלי): נשלח webhook כאשר כל התרגומים מסתיימים, אם סופק callback_url

Webhook Callback

כאשר מסופק callback_url, נשלחת בקשת POST עם סיום המשימה.

גוף בקשת ה־callback:

{
  "id": 1,
  "status": "completed",
  "translations_url": "https://app.ptc.wpml.org/api/v1/content_translation/1"
}

סוגי נתונים נתמכים

סוג JSON התנהגות תרגום
string מתורגם לשפות היעד
number נשמר כפי שהוא
boolean נשמר כפי שהוא
null נשמר כפי שהוא
array מעובד באופן רקורסיבי
object מעובד באופן רקורסיבי

דוגמאות לבקשות

תרגום JSON בסיסי:

curl -X POST "https://app.ptc.wpml.org/api/v1/content_translation" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "welcome": "Welcome",
      "buttons": {
        "save": "Save",
        "cancel": "Cancel"
      }
    },
    "name": "UI Labels"
  }'

עם שפות יעד ספציפיות:

curl -X POST "https://app.ptc.wpml.org/api/v1/content_translation" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "title": "Product Catalog",
      "categories": {
        "electronics": "Electronics",
        "clothing": "Clothing"
      }
    },
    "target_languages": ["es", "fr"],
    "callback_url": "https://myapp.com/webhook"
  }'

דוגמאות קוד

curl -X POST "https://app.ptc.wpml.org/api/v1/content_translation" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"data":{"app":{"title":"My Application","navigation":{"home":"Home","about":"About Us"}}},"name":"App Translations","target_languages":["es","fr","de"],"callback_url":"https://your-app.com/webhooks/complete"}'

# The response includes the job "id". Poll its status (status stays
# "in_progress" until done — it is not set on the create response):
curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/CONTENT_TRANSLATION_ID/status" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Content Translations

מאחזר את התוכן המקורי ואת כל הגרסאות המתורגמות עבור משימת תרגום תוכן ספציפית.

התשובה שומרת על מבנה הקלט שלכם: היא מחזירה אובייקט מקור בתוספת אובייקט אחד לכל שפת יעד (מזוהה על ידי קוד השפה, כגון es, fr, de).

בקשת HTTP

GET https://app.ptc.wpml.org/api/v1/content_translation/{id}

פרמטרי נתיב

פרמטר סוג חובה תיאור
id מספר שלם כן המזהה הייחודי של משימת תרגום התוכן שיש לאחזר.

תשובות

תשובת הצלחה

200 OKapplication/json
{
  "source": {
    "app": {
      "title": "My Application",
      "navigation": {
        "home": "Home",
        "about": "About",
        "contact": "Contact"
      },
      "buttons": {
        "save": "Save",
        "cancel": "Cancel"
      }
    }
  },
  "es": {
    "app": {
      "title": "Mi Aplicación",
      "navigation": {
        "home": "Inicio",
        "about": "Acerca de",
        "contact": "Contacto"
      },
      "buttons": {
        "save": "Guardar",
        "cancel": "Cancelar"
      }
    }
  },
  "fr": {
    "app": {
      "title": "Mon Application",
      "navigation": {
        "home": "Accueil",
        "about": "À propos",
        "contact": "Contact"
      },
      "buttons": {
        "save": "Enregistrer",
        "cancel": "Annuler"
      }
    }
  }
}

סכמת התשובה

שדה סוג תיאור
source אובייקט תוכן המקור המקורי באותו מבנה מקונן כפי שהוגש.
{language_code} אובייקט התוכן המתורגם עבור כל שפת יעד, מזוהה על ידי קוד ה־ISO שלה (לדוגמה es, fr, de), באותו מבנה כמו המקור. למידע נוסף, ראו API שפות יעד זמינות.

תשובות שגיאה

תרגום התוכן לא נמצא
404 Not Found
{
  "error": "Content translation not found"
}
לא מורשה
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
גישה נדחתה
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

דוגמאות לבקשות

בקשה בסיסית:

curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/123" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

דוגמאות קוד

curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get the Content Translation Status

מאחזר את הסטטוס הנוכחי של משימת תרגום תוכן ספציפית.

התשובה משקפת את ההתקדמות הכללית וכוללת האם התרגום נמצא בתור, בתהליך, הושלם או נכשל.

בקשת HTTP

GET https://app.ptc.wpml.org/api/v1/content_translation/{id}/status

פרמטרי נתיב

פרמטר סוג חובה תיאור
id מספר שלם כן המזהה הייחודי של משימת תרגום התוכן לבדיקה.

תשובות

תשובת הצלחה

200 OKapplication/json
{
  "status": "completed",
  "completeness": 100
}
סכמת התשובה
שדה סוג תיאור
status מחרוזת סטטוס התרגום הנוכחי. ערכי הסטטוס האפשריים כוללים: queued, in_progress, completed, failed, status_unknown.
completeness מספר אחוז ההשלמה של המחרוזות שתורגמו (0–100). מחושב כ־(completed_translatable_strings / total_translatable_strings) × 100.
ערכי סטטוס
סטטוס תיאור
queued התרגום הוכנס לתור וממתין לעיבוד.
in_progress התרגום נמצא כעת בעיבוד.
completed התרגום הושלם בהצלחה.
failed התרגום נכשל עקב שגיאה.
status_unknown סטטוס התרגום אינו ידוע או שעדיין לא ניתן לקבוע אותו.

תשובות שגיאה

404 Not Found

סיבות אפשריות:

  • לא קיים תרגום תוכן עם המזהה שצוין
  • משימת התרגום אינה שייכת לפרויקט המאומת

דוגמה

curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/123/status" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

תשובה:

{
  "status": "completed",
  "completeness": 100
}

תשובה בזמן שהמשימה עדיין רצה:

{
  "status": "in_progress",
  "completeness": 70
}
{
  "status": "completed",
  "completeness": 100
}