API מילון מונחים
עדכון מילון המונחים
POST/v1/glossary/update
עדכון פרטי מונחון או מונחים.
- כתובת מלאה
- https://shangyiai.com/api/v1/glossary/update
- אימות
- יש להעביר את ה-API Key בכותרת הבקשה Authorization
- Content-Type
- application/json
- פורמט שגוי
- { "error": "Invalid API key." }
נקודות לתשומת לב
שדות שלא הועברו ישמרו על ערכם המקורי.
אם מעדכנים keys, מומלץ לעדכן במקביל את translated, כדי להבטיח שלכל מונח מקור יש תרגום מתאים.
דוגמה
curl
1curl -X POST 'https://shangyiai.com/api/v1/glossary/update' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data '{
5 "glossaryId": "[string]",
6 "name": "0twXbd",
7 "keys": [
8 "储蓄分流"
9 ],
10 "translated": {
11 "储蓄分流": "Diversion of household deposits"
12 }
13}'פרמטרי בקשה
| פרמטרים | סוג | ברירת מחדל | תיאור | דוגמה |
|---|---|---|---|---|
| *glossaryId | String | - | מזהה רשימת המונחים | - |
| name | String | - | שם | מונחים פיננסיים 2 |
| desc | String | - | תיאור | - |
| targetLang | String | - |
| - |
| keys | String[] | - | מערך של כל המונחים | ["储蓄分流"] |
| translated | JSON | - | מפת התרגומים המתאימים למונחים | {"储蓄分流":"Diversion of household deposits"} |
תגובה
| פרמטרים | סוג | ברירת מחדל | תיאור | דוגמה |
|---|---|---|---|---|
| glossaryId | String | - | מזהה רשימת המונחים | - |
| name | String | - | שם | - |
| desc | String | - | תיאור | - |
| targetLang | String | - | שפת יעד | - |
| keys | String[] | - | מערך של כל המונחים | - |
| translated | JSON | - | מפת התרגומים המתאימים למונחים | - |
| createdAt | DateTime | - | זמן יצירת רשימת המונחים | - |
| updatedAt | DateTime | - | זמן עדכון מילון המונחים | - |
שגיאות נפוצות
401 Missing API key.
The Authorization request header is required.
401 Invalid API key.
The API key does not exist, has been deleted, or is no longer valid.
400 Missing required parameter: glossaryId.
Provide the glossaryId returned by the create glossary API.
404 Glossary not found.
The glossary does not exist or does not belong to the current API account.