API глоссария
Обновить глоссарий
Обновите параметры глоссария или термины.
- Полный адрес
- https://otranslator.com/api/v1/glossary/update
- Аутентификация
- Необходимо передать API Key в заголовке запроса Authorization
- Content-Type
- application/json
- Ошибочный формат
- { "error": "Invalid API key." }
Меры предосторожности
Непереданные поля сохранят исходные значения.
При обновлении keys рекомендуется также обновлять translated, чтобы обеспечить наличие соответствующего перевода для каждого исходного термина.
Пример
1curl -X POST 'https://otranslator.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 | - | ID глоссария | - |
| name | String | - | Название | Финансовые термины2 |
| desc | String | - | Описание | - |
| targetLang | String | - |
| - |
| keys | String[] | - | Массив всех терминов | ["储蓄分流"] |
| translated | JSON | - | Карта соответствий терминов и их переводов | {"储蓄分流":"Diversion of household deposits"} |
Ответ
| Параметры | Тип | По умолчанию | Описание | Пример |
|---|---|---|---|---|
| glossaryId | String | - | ID глоссария | - |
| 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.