הירשם כמפתח וקבל מפתח API
מספק ממשקי API מסוג RESTful לתרגום מסמכים, תומך בניהול משימות תרגום אוטומטיות, עקביות טרמינולוגית מבוססת מילון מונחים, ושאילתות לפורמטים נתמכים, שפות ומודלים, מה שמאפשר בניית תהליכי עבודה חלקים לתרגום וניהול חשבונות משתמש.
תחילת העבודה
כדי להתחיל, עליכם להגיש בקשה להפוך למפתחים.הגש מועמדות כמפתח
לאחר האישור, ניתן ליצור מפתחות API מרובים ולכלול את מפתח ה-API המתאים בכל בקשת API כנדרש.
גישה מהירה
כתובת URL בסיסית
https://otranslator.com/api
שיטת אימות
Authorization: [yourSecretKey]
בקשת JSON
מלבד ממשק העלאת קבצים, ממשקים משתמשים כברירת מחדל בבקשות POST JSON, כאשר Content-Type הוא application/json.
העלאת קובץ
יצירת משימת תרגום מסמכים משתמשת ב-multipart/form-data, שדה file מעביר את הקובץ המיועד לתרגום.
תגובת שגיאה כללית
כאשר הבקשה נכשלת, הממשק יחזיר JSON, שדה error מכיל מידע שגיאה קבוע באנגלית. מומלץ לטפל בשגיאות בעדיפות על פי HTTP status code, שדה error משמש להצגה או לרישום ביומן.
{
"error": "Invalid API key."
}כללים לקוד מצב שגיאה
כל תשובות השגיאה של v1 API שומרות על אותו מבנה, אנא טפל בהן לפי כללי קוד הסטטוס HTTP הבאים.
- 400 Bad Request
- פרמטרים נדרשים חסרים, פורמטים של פרמטרים או ערכי enum לא תקינים, העלאת קובץ חסרה, כשל בשמירת העלאה, או כשל בעיבוד משימה.
- 401 Unauthorized
- מפתח API חסר או לא תקין.
- 402 Payment Required
- אין מספיק קרדיטים לתצוגה מקדימה, תרגום מלא או תרגום של טקסט.
- 404 Not Found
- המשימה או מילון המונחים אינם קיימים, נמחקו, אינם שייכים לחשבון ה-API הנוכחי, או לא נוצרו דרך ה-API.
- 409 Conflict
- מצב המשימה הנוכחי אינו מאפשר את הפעולה המבוקשת.
- 500 Internal Server Error
- חריגת שרת בלתי צפויה. שגיאת התגובה מתוקנת כ-"שגיאת שרת פנימית.".
תהליך שילוב מומלץ
1. יצירת משימה
העלאת קובץ ויצירת משימת תרגום, מחזירה taskId.
2. בדיקת התקדמות
ביצוע בדיקה מחזורית של סטטוס המשימה עד להשגת Completed, Terminated או Cancelled.
3. קבלת תוצאות
הורדת קובץ מתורגם, או קריאת JSON של המקור והתרגום.
4. ניהול משימות
תשלום לפי דרישה עבור תרגום טקסט מלא, הפעלה מחדש של משימה, תיקון טקסט או מחיקת משימה.