PTC

העלאה וניהול של קובצי מקור באמצעות ה־API

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

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

כיצד ה-API של PTC מזהה ומארגן קובצי מקור

ה-API של PTC משתמש במערכת גמישה המבוססת על תגיות קבצים (file tags) ועל נתיבי קבצים (file paths). פרמטרים אלו עובדים יחד כדי להבטיח שכל קובץ שאתם מעלים, מעדכנים או מבקשים יהיה מוגדר בבירור וקל לניהול.

תגיות קבצים

תגיות קבצים הן דרך גמישה לקבץ ולארגן קובצי מקור בפרויקטי תרגום. תוכלו להשתמש בהן כקטגוריות שמתאימות לצרכי זרימת העבודה שלכם. לדוגמה, תגיות קבצים יכולות לציין:

  • בקרת גרסאות: v1.0, beta, production
  • ענפי פיצ'רים (Feature branches): user-auth, dashboard-redesign
  • הקשר האפליקציה: mobile-app, admin-panel, marketing
  • בעלות של צוותים: frontend-team, content-team
  • מצב זרימת העבודה: approved, pending-review, priority-high

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

שם תגית קובץ + נתיב קובץ

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

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

פרמטרי שאילתה (Query Parameters)

בעת שליפת קובץ ספציפי, נקודות קצה (endpoints) רלוונטיות יכולות לקבל פרמטרי שאילתה כגון:

  • file_tag_name – התגית המשויכת לקובץ
  • file_path – הנתיב לקובץ

פרמטרים אלו מאפשרים לכם לאתר ולשלוף במדויק את הקבצים הנכונים מהפרויקט שלכם.


רשימת כל קובצי המקור בפרויקט

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

בקשת HTTP

GET https://app.ptc.wpml.org/api/v1/source_files

פרמטרים

פרמטר סוג חובה ברירת מחדל תיאור
page integer לא 1 מספר העמוד לצורך חלוקה לעמודים. חייב להיות גדול מ־0.
per_page integer לא 50 מספר הפריטים בכל עמוד. חייב להיות גדול מ־0.
order_by string לא created_at השדה שלפיו יתבצע המיון. ערכים מותרים: id, created_at, updated_at.
sort string לא desc כיוון המיון. ערכים מותרים: asc, desc.
file_path string לא מסנן לפי נתיב קובץ מדויק.
upload_origin string לא מסנן לפי האופן שבו הקובץ הועלה. הערכים המותרים כוללים: git, manual, api.

תגובות

תגובת הצלחה

200 OKapplication/json
{
  "source_files": [
    {
      "id": 123,
      "file_path": "locales/en.po",
      "translation_path": "locales/{{lang}}.po",
      "additional_translation_files": ["locales/{{lang}}.mo"],
      "status": "completed",
      "upload_origin": "git",
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T14:20:00.000Z",
      "file_tag": {
        "id": 456,
        "name": "frontend"
      },
      "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po&file_tag_name=frontend"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 150,
    "total_pages": 3,
    "has_next_page": true,
    "has_previous_page": false
  }
}
סכימת התגובה

אובייקט קובץ מקור (Source File Object):

שדה סוג תיאור
id integer המזהה הייחודי של קובץ המקור.
file_path string הנתיב לקובץ המקור בתוך הפרויקט.
translation_path string התבנית שלפיה יישמרו הקבצים המתורגמים.
additional_translation_files array[string] הנתיבים עבור קובצי פלט נוספים.
status string סטטוס העיבוד הנוכחי של קובץ המקור.
upload_origin string האופן שבו הקובץ הועלה (git, manual, api).
created_at string חותמת זמן בתקן ISO 8601 המציינת מתי נוצר קובץ המקור במקור.
updated_at string חותמת זמן בתקן ISO 8601 המציינת מתי קובץ המקור עודכן לאחרונה.
file_tag object מידע על תגית הקובץ.
file_tag.id integer מזהה תגית הקובץ.
file_tag.name string שם תגית הקובץ.
download_url string הכתובת (URL) להורדת תרגומים עבור קובץ מקור זה.

אובייקט חלוקה לעמודים (Pagination Object):

שדה סוג תיאור
page integer מספר העמוד הנוכחי.
per_page integer מספר הפריטים בכל עמוד.
total integer המספר הכולל של קובצי מקור.
total_pages integer המספר הכולל של עמודים.
has_next_page boolean האם קיים עמוד הבא.
has_previous_page boolean האם קיים עמוד קודם.

תגובות שגיאה

Unauthorized (לא מורשה)
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Forbidden (גישה אסורה)
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
Invalid Parameters (פרמטרים לא תקינים)
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

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

בקשה בסיסית:

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

בקשה עם סינון:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files?file_tag_name=frontend&page=1&per_page=25&order_by=updated_at&sort=desc" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

דוגמאות קוד

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files?file_tag_name=frontend&page=1&per_page=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

קבלת מחרוזות תרגום

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

נקודת קצה (endpoint) זו שימושית להבאת תוכן שצריך לתרגם או תוכן שכבר תורגם. קובץ המקור מזוהה באמצעות file_path ו־file_tag_name.

בקשת HTTP

GET https://app.ptc.wpml.org/api/v1/source_files/translation_strings

פרמטרים

פרמטר סוג חובה ברירת מחדל תיאור
file_path string כן הנתיב לקובץ המקור בתוך הפרויקט.
file_tag_name string לא שם תגית הקובץ. אם לא צוין, ייעשה שימוש בתגית ברירת המחדל של הפרויקט.
page integer לא 1 מספר העמוד עבור חלוקה לעמודים (משמש כסמן/cursor). חייב להיות גדול מ־0.
q string לא שאילתת חיפוש לסינון מחרוזות תרגום לפי טקסט המקור שלהן.

תגובות

תגובת הצלחה

200 OKapplication/json
{
  "total_strings_count": 1250,
  "translation_strings": [
    {
      "source": "Welcome to our application",
      "translations": {
        "es": "Bienvenido a nuestra aplicación",
        "fr": "Bienvenue dans notre application",
        "de": "Willkommen in unserer Anwendung"
      }
    },
    {
      "source": "Login",
      "translations": {
        "es": "Iniciar sesión",
        "fr": "Connexion",
        "de": "Anmelden"
      }
    }
  ],
  "cursor": 1
}
סכימת תגובה
שדה סוג תיאור
total_strings_count integer המספר הכולל של מחרוזות ניתנות לתרגום בקובץ המקור.
translation_strings array[object] מערך של אובייקטי מחרוזות תרגום (מחולק לעמודים, מקסימום 500 לעמוד).
translation_strings[].source string טקסט המקור המקורי המיועד לתרגום.
translation_strings[].translations object Hash של תרגומים שבו המפתחות הם קודי ISO של השפה והערכים הם הטקסט המתורגם.
cursor integer סמן העמוד הנוכחי המשמש לחלוקה לעמודים.

תגובות שגיאה

קובץ מקור לא נמצא
404 Not Found
{
  "error": "Source file not found"
}
לא מורשה
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
גישה אסורה
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
פרמטרים לא תקינים
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

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

בקשה בסיסית:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

בקשה עם תגית קובץ:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

בקשה עם חלוקה לעמודים וחיפוש:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po&file_tag_name=frontend&page=2&q=welcome" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

דוגמאות קוד

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po&file_tag_name=frontend&page=1&q=login" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

יצירת קובץ מקור

רישום קובץ מקור חדש בפרויקט שלכם כדי שיהיה מוכן לתרגום.

נקודת קצה (endpoint) זו יוצרת את רשומת הקובץ ומגדירה את תצורת התרגום שלו, אך היא אינה מצרפת את תוכן הקובץ בפועל.

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

בקשת HTTP

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

פרמטרים

פרמטר סוג חובה תיאור
file_path string כן הנתיב שבו קובץ המקור אמור להישמר בפרויקט. חייב לכלול סיומת נתמכת.
output_file_path string כן תבנית נתיב הפלט עבור הקבצים המתורגמים. השתמשו ב־{{lang}} כמציין מיקום עבור קוד השפה.
translations array[object] לא קבצי תרגום קיימים להעלאה לצד קובץ המקור. קבצים אלו יישמרו כפי שסופקו, והמחרוזות שבהם לא יתורגמו מחדש על ידי PTC. שימו לב שמתן תרגומים קיימים אינו מומלץ, כיוון ש־PTC מפיקה תוצאות טובות יותר כאשר היא יכולה להשתמש בהקשר המלא של הפרויקט ולתרגם מאפס.
translations[].target_language_iso string כן קוד ה־ISO של שפת היעד עבור תרגום זה. ניתן למצוא את הרשימה המלאה של השפות הנתמכות וקודי ה־ISO שלהן בנקודת הקצה לפירוט כל שפות היעד.
translations[].file file כן קובץ התרגום להעלאה.
additional_translation_files array[object] לא תצורות קבצי פלט נוספות עבור פורמטים ספציפיים. כדי לראות אילו פורמטים תומכים בקבצי פלט נוספים, עיינו בנקודת הקצה לפירוט פורמטי קבצים נתמכים. עבור פורמטים שאינם נתמכים, שדה זה יתעלם.
additional_translation_files[].type string כן ראו פורמטי קבצים נתמכים לפרטים נוספים.
additional_translation_files[].path string כן תבנית הנתיב עבור הקובץ.

תגובות

תגובת הצלחה

201 Createdapplication/json
{
  "source_file": {
    "id": 123,
    "file_path": "src/locales/en.json",
    "created_at": "2024-01-15T10:30:00.000Z",
    "file_tag": {
      "id": 456,
      "name": "frontend"
    }
  }
}
סכימת תגובה
שדה סוג תיאור
source_file.id integer המזהה הייחודי עבור קובץ המקור שנוצר.
source_file.file_path string נתיב קובץ המקור בתוך הפרויקט.
source_file.created_at string חותמת זמן בפורמט ISO 8601 המציינת מתי נוצר קובץ המקור במקור.
source_file.file_tag.id integer מזהה תגית הקובץ.
source_file.file_tag.name string שם תגית הקובץ.

תגובות שגיאה

אימות נכשל
422 Unprocessable Entity
{
  "success": false,
  "error": "Source file creation failed"
}
לא מורשה
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
גישה אסורה
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

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

יצירת קובץ מקור בסיסית:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/locales/en.json" \
  -F "output_file_path=src/locales/{{lang}}.json" \
  -F "file_tag_name=frontend"

בקשה עם URL עבור callback:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/locales/messages.po" \
  -F "output_file_path=locales/{{lang}}/messages.po" \
  -F "callback_url=https://your-app.com/webhooks/translation-complete"

בקשה עם תרגומים קיימים:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/messages.json" \
  -F "output_file_path=locales/{{lang}}/messages.json" \
  -F "translations[0][target_language_iso]=es" \
  -F "translations[0][file]=@spanish_translations.json" \
  -F "translations[1][target_language_iso]=fr" \
  -F "translations[1][file]=@french_translations.json"

בקשה עם קבצי פלט נוספים:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/messages.po" \
  -F "output_file_path=locales/{{lang}}/messages.po" \
  -F "additional_translation_files[][type]=mo" \
  -F "additional_translation_files[][path]=locales/{{lang}}/messages.mo" \
  -F "additional_translation_files[][type]=json" \
  -F "additional_translation_files[][path]=locales/{{lang}}/messages.json"

דוגמאות קוד

  • JavaScript (FormData)
  • Python (requests)
  • PHP (cURL)
  • Node.js (axios)
  • גוף בקשת Callback
curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/locales/en.json" \
  -F "output_file_path=src/locales/{{lang}}.json"
{
  "source_file_id": 123,
  "status": "completed",
  "file_tag_name": "frontend",
  "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=src/locales/en.json&file_tag_name=frontend",
  "file_path": "src/locales/en.json"
}

עיבוד קובץ המקור

מעלה תוכן לקובץ מקור קיים ומתחיל את תהליך התרגום.

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

כדי להשתמש בנקודת קצה זו, קובץ המקור חייב להיות כבר קיים בפרויקט. אם טרם יצרתם אותו, ראו יצירת קובץ המקור.

בקשת HTTP

PUT https://app.ptc.wpml.org/api/v1/source_files/process

פרמטרים

פרמטר סוג חובה תיאור
file file כן קובץ המקור להעלאה. תוכן הקובץ עובר אימות כדי לוודא שהוא תואם לסיומת המוצהרת שלו. לדוגמה, אם סיומת הקובץ היא .json, התוכן המועלה חייב להיות JSON תקין.
file_path string כן הנתיב לקובץ המקור הקיים בפרויקט שאותו יש לעדכן.
file_tag_name string לא שם תגית הקובץ המשויכת לקובץ המקור. אם לא צוין, ייעשה שימוש בתגית ברירת המחדל של הפרויקט.
callback_url string לא כתובת ה־URL שתקבל התראות webhook עם סיום עיבוד הקובץ.

תגובות

תגובת הצלחה

200 OKapplication/json
{
  "source_file": {
    "id": 123,
    "file_path": "src/locales/en.json",
    "created_at": "2024-01-15T10:30:00.000Z",
    "file_tag": {
      "id": 456,
      "name": "frontend"
    }
  }
}
סכימת תגובה
שדה סוג תיאור
source_file.id integer המזהה הייחודי של קובץ המקור שעובד.
source_file.file_path string נתיב קובץ המקור בתוך הפרויקט.
source_file.created_at string חתימת זמן בפורמט ISO 8601 המציינת מתי נוצר קובץ המקור במקור.
source_file.file_tag.id integer מזהה תגית הקובץ.
source_file.file_tag.name string שם תגית הקובץ.

תגובות שגיאה

קובץ מקור לא נמצא
422 Unprocessable Entity
{
  "errors": {
    "file": ["File format is invalid or not supported"]
  }
}
לא מורשה (Unauthorized)
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
גישה אסורה (Forbidden)
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

תהליך עבודה

  1. דרישה מוקדמת: קובץ המקור חייב להיווצר מראש באמצעות יצירת קובץ המקור.
  2. העלאת קובץ: תוכן חדש מועלה ומחליף את תוכן הקובץ הקיים.
  3. עיבוד: המחרוזות החדשות לתרגום מחולצות ומתורגמות אוטומטית.
  4. Callback: התראת webhook אופציונלית נשלחת עם סיום העיבוד.

Webhook Callback

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

גוף בקשת ה־Callback:

{
  "source_file_id": 123,
  "status": "completed",
  "file_tag_name": "frontend",
  "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=src/locales/en.json&file_tag_name=frontend",
  "file_path": "src/locales/en.json"
}

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

עיבוד קובץ בסיסי:

curl -X PUT "https://app.ptc.wpml.org/api/v1/source_files/process" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@updated_translations.json" \
  -F "file_path=src/locales/en.json" \
  -F "file_tag_name=frontend"

בקשה עם כתובת URL ל־callback:

curl -X PUT "https://app.ptc.wpml.org/api/v1/source_files/process" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@messages.po" \
  -F "file_path=locales/messages.po" \
  -F "callback_url=https://your-app.com/webhooks/translation-complete"

דוגמאות קוד

curl -X PUT "https://app.ptc.wpml.org/api/v1/source_files/process" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@updated_translations.json" \
  -F "file_path=src/locales/en.json" \
  -F "file_tag_name=frontend" \
  -F "callback_url=https://your-app.com/webhooks/complete"

פורמטי קבצים נתמכים

נקודת הקצה תומכת בפורמטים שונים של קבצים לתרגום, כולל JSON, PO/POT, XLIFF וקובצי Properties, בין היתר. אימות פורמט הקובץ מתבצע במהלך ההעלאה כדי להבטיח תאימות.

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


קבלת סטטוס התרגום

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

פעולה זו שימושית עבור:

  • ניטור התקדמות – מעקב אחר התקדמות התרגום בעבודות ארוכות
  • עדכוני ממשק משתמש – הצגת אחוזי השלמה בתוך האפליקציה שלכם
  • אינטגרציה עם תהליכי עבודה – הפעלת פעולות כאשר התרגום מגיע לסף מוגדר

בקשת HTTP

GET https://app.ptc.wpml.org/api/v1/source_files/translation_status

פרמטרים

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

תגובות

תגובת הצלחה

200 OKapplication/json
{
  "translation_status": {
    "status": "completed",
    "completeness": 100
  }
}
סכמת התגובה
שדה סוג תיאור
translation_status.status string סטטוס העיבוד הנוכחי של קובץ המקור. ראו ערכי סטטוס להלן.
translation_status.completeness number אחוז המחרוזות שתורגמו (0–100). מחושב לפי (completed_translatable_strings / total_translatable_strings) × 100.

ערכי סטטוס

השדה status יכול להכיל את הערכים הבאים:

סטטוס תיאור
pending קובץ המקור ממתין לעיבוד.
processing התרגום נמצא כעת בתהליך.
completed כל התרגומים הושלמו.
failed תהליך התרגום נתקל בשגיאות.

תגובות שגיאה

קובץ מקור לא נמצא
404 Not Found
{
  "error": "Source file not found"
}
לא מורשה (Unauthorized)
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
גישה אסורה (Forbidden)
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
פרמטרים לא תקינים
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

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

בקשה בסיסית:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_status?file_path=locales/en.po" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

בקשה עם תגית קובץ:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_status?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

דוגמאות קוד

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_status?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

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

הורדת כל הקבצים המתורגמים עבור קובץ מקור ספציפי כארכיון ZIP.

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

אם אין תרגומים זמינים עבור הקובץ, הבקשה תחזיר שגיאת 404 Not Found.

בקשת HTTP

GET https://app.ptc.wpml.org/api/v1/source_files/download_translations

פרמטרים

פרמטר סוג חובה תיאור
file_path string כן הנתיב לקובץ המקור בתוך הפרויקט.
file_tag_name string לא שם תגית הקובץ. אם לא צוין, ייעשה שימוש בתגית ברירת המחדל של הפרויקט. קובץ מקור מזוהה באופן ייחודי על ידי השילוב של file_path ו־file_tag_name.

תגובות

תגובת הצלחה

200 OKapplication/zip202 AcceptedRetry-After: 30
{
  "status": "processing",
  "message": "Translations are still in progress. Please retry after the specified delay.",
  "retry_after": 30
}

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

כשזה קורה, המתינו את מספר השניות שצוין ב־Retry-After.

תגובות שגיאה

קובץ מקור לא נמצא
404 Not Found
{
  "error": "Source file not found"
}
אין תרגומים זמינים
404 Not Found
{
  "error": "No translations are available for this source file"
}
לא מורשה (Unauthorized)
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
גישה אסורה (Forbidden)
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
פרמטרים לא תקינים
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

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

בקשה בסיסית:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -o translations.zip

בקשה עם תגית קובץ:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -o frontend-translations.zip

דוגמאות קוד

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -o translations.zip
# 200 -> saves the zip; 202 -> {"status":"processing","retry_after":N} (retry later);
# 404 -> {"error":"No translations are available for this source file"}

העלאת קובצי מקור בכמות גדולה

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

זוהי גרסת batch של עיבוד קובץ המקור, שנועדה להאיץ עדכונים בקנה מידה גדול.

מידע נוסף

  • אם קובץ תואם לקובץ מקור קיים, הוא מעודכן בתוכן החדש, והתרגומים מופעלים מחדש.
  • אם קובץ נתמך אך אינו תואם לאף קובץ מקור קיים, הוא מתווסף לרשימת not_found_files ומתעלמים ממנו.
  • קבצים בפורמטים שאינם נתמכים מופיעים תחת unsupported_files ומתעלמים מהם.
  • קבצים עם תוכן לא תקין מופיעים גם הם תחת unsupported_files ומתעלמים מהם.
  • עיבוד ארכיונים גדולים עשוי להימשך זמן רב יותר. הקבצים מעובדים אחד אחד כדי לנהל משאבים, לכן מומלץ לפצל העלאות גדולות מאוד (יותר מ-100 קבצים) לקבוצות קטנות יותר. כל הקבצים בארכיון מוגדרים לתרגום אוטומטי.
  • קובץ ה-ZIP המועלה חייב להיות תקין וקריא. כל הקבצים בתוכו חייבים להיות בפורמט נתמך. שמות הקבצים לא צריכים לכלול תווים מיוחדים שעלולים לגרום לבעיות בנתיב (path).
  • אם צוין callback_url, נשלחת בקשת POST עבור כל קובץ מקור שעובד עם התוצאות שלו.

בקשת HTTP

POST https://app.ptc.wpml.org/api/v1/source_files/bulk

פרמטרים

פרמטר סוג חובה תיאור
zip_file file כן ארכיון ZIP המכיל את קובצי המקור להעלאה. עליו להיות קובץ ZIP תקין.
file_tag_name string לא שם תג הקובץ שישויך לכל קובצי המקור בארכיון. אם לא צוין, נעשה שימוש בתג הקובץ המחדל של הפרויקט. כל קובץ מקור מזוהה באופן ייחודי על ידי השילוב של file_path ו-file_tag_name.
callback_url string לא הכתובת (URL) שתקבל התראות webhook כאשר כל קובץ מעובד.

מבנה קובץ ZIP צפוי

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

דוגמה למבנה ZIP:

source-files.zip
├── locales/
│   ├── messages-en.po
│   ├── validation-en.po
│   └── admin-en.po
├── frontend/
│   ├── components-en.json
│   └── pages-en.json
│   └── not-found-en.json
├── app-strings-en.properties
└── readme.txt (will be ignored)

סוגי קבצים נתמכים:

  • JSON: קובצי .json
  • Gettext: קובצי .po, ‏.pot
  • Properties: קובצי .properties
  • YAML: קובצי .yml, ‏.yaml
  • XML: קובצי .xml
  • Strings: קובצי .strings
  • XLIFF: קובצי .xliff, ‏.xlf
  • CSV: קובצי .csv
  • PHP: קובצי .php

תגובות

תגובת הצלחה

200 OKapplication/json
{
  "success": true,
  "file_tag": {
      "id": 456,
      "name": "backend"
  },
  "processed_files": [
    {
      "id": 123,
      "file_path": "locales/messages-en.po",
      "created_at": "2024-01-15T10:30:00.000Z",
      "file_tag": {
        "id": 456,
        "name": "backend"
      }
    },
    {
      "id": 124,
      "file_path": "locales/validation-en.po",
      "created_at": "2024-01-15T10:30:05.000Z",
      "file_tag": {
        "id": 456,
        "name": "backend"
      }
    }
  ],
  "unsupported_files": [
    "readme.txt",
    "config.ini"
  ],
  "not_found_files": ["frontend/not-found-en.json"]
}
סכימת תגובה
שדה סוג תיאור
success boolean האם פעולת ההעלאה בכמות גדולה הצליחה.
file_tag object מידע על תג הקובץ.
file_tag.id integer מזהה תג הקובץ.
file_tag.name string שם תג הקובץ.
processed_files array[object] מערך של קובצי מקור שעובדו בהצלחה.
processed_files[].id integer המזהה הייחודי עבור קובץ המקור שנוצר.
processed_files[].file_path string הנתיב של קובץ המקור, תוך שמירה על מבנה ה-ZIP המקורי.
processed_files[].created_at string חתימת זמן בפורמט ISO 8601 המציינת מתי נוצר קובץ המקור.
processed_files[].file_tag object מידע על תג הקובץ.
processed_files[].file_tag.id integer מזהה תג הקובץ.
processed_files[].file_tag.name string שם תג הקובץ.
unsupported_files array[string] מערך של שמות קבצים שאינם בפורמט נתמך.
not_found_files array[string] מערך של קבצים נתמכים שלא תאמו לאף קובץ מקור קיים וזכו להתעלמות.

תגובות שגיאה

קובץ ZIP לא תקין

422 Unprocessable Entity
{
  "success": false,
  "error": "File format is invalid",
  "processed_files": [],
  "unsupported_files": []
}

העיבוד נכשל

422 Unprocessable Entity
{
  "success": false,
  "error": "Failed to process ZIP archive",
  "processed_files": [],
  "unsupported_files": []
}

לא מורשה (Unauthorized)

401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}

אסור (Forbidden)

403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

Webhook Callback

כאשר מסופק callback_url, נשלחת בקשת POST עבור כל קובץ שעובד.

גוף בקשת ה-Callback (לכל קובץ):

{
  "source_file_id": 123,
  "status": "completed",
  "file_tag_name": "backend",
  "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/messages-en.po&file_tag_name=backend",
  "file_path": "locales/messages-en.po"
}

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

העלאה בסיסית בכמות גדולה:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files/bulk" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "zip_file=@source-files.zip" \
  -F "file_tag_name=backend"

בקשה עם URL ל-callback:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files/bulk" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "zip_file=@translations.zip" \
  -F "file_tag_name=localization" \
  -F "callback_url=https://your-app.com/webhooks/bulk-complete"

דוגמאות קוד

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files/bulk" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "zip_file=@source-files.zip" \
  -F "file_tag_name=backend" \
  -F "callback_url=https://your-app.com/webhooks/complete"
המשך קריאה:

מציאת פורמטים נתמכים ושפות יעד באמצעות ה-API ←