PTC

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

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

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

Create Content Translations

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

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

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

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

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

בקשת HTTP

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

פרמטרים

פרמטר סוג חובה תיאור
data object כן הנתונים המובנים ב־JSON לתרגום. הם יכולים לכלול אובייקטים מקוננים, מערכים וערכי מחרוזות.
name string לא שם קריא למשתמש עבור משימת התרגום. אם יושמט, ייווצר שם באופן אוטומטי.
callback_url string לא כתובת ה־URL שמקבלת הודעות webhook כאשר התרגום מסתיים.
target_languages array[string] לא מערך של קודי 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 number המזהה הייחודי של משימת תרגום התוכן.
name string שם המשימה (נוצר אוטומטית אם לא סופק).
status string הסטטוס הנוכחי של המשימה (queued, processing, completed).
created_at string חותמת הזמן בפורמט ISO 8601 המציינת מתי נוצרה המשימה.
updated_at string חותמת הזמן בפורמט 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"]
  }
}
לא מורשה (Unauthorized)
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
אסור (Forbidden)
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 (the create response
# carries a "status" field as well, but it is usually null until the run
# starts, and stays "in_progress" until done):
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

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

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

בקשת HTTP

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

פרמטרי נתיב

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

תגובות

תגובת הצלחה

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 object תוכן המקור המקורי באותו מבנה מקונן כפי שנשלח.
{language_code} object התוכן המתורגם עבור כל שפת יעד, מזוהה על ידי קוד ה־ISO שלה (לדוגמה es, fr, de), עם אותו מבנה כמו המקור. למידע נוסף, ראו API שפות יעד זמינות.

תגובות שגיאה

תרגום התוכן לא נמצא
404 Not Found
{
  "error": "Content translation not found"
}
לא מורשה (Unauthorized)
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
אסור (Forbidden)
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 integer כן המזהה הייחודי של משימת תרגום התוכן לבדיקה.

תגובות

תגובת הצלחה

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

תגובות שגיאה

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
}