API глоссария
Запросить глоссарий
POST/v1/glossary/query
Получить сведения о глоссарии по ID.
- Полный адрес
- https://otranslator.com/api/v1/glossary/query
- Аутентификация
- Необходимо передать API Key в заголовке запроса Authorization
- Content-Type
- application/json
- Ошибочный формат
- { "error": "Invalid API key." }
Пример
curl
1curl -X POST 'https://otranslator.com/api/v1/glossary/query' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data '{
5 "glossaryId": "[string]"
6}'Параметры запроса
| Параметры | Тип | По умолчанию | Описание | Пример |
|---|---|---|---|---|
| *glossaryId | String | - | ID глоссария | - |
Ответ
| Параметры | Тип | По умолчанию | Описание | Пример |
|---|---|---|---|---|
| glossaryId | String | - | ID глоссария | - |
| name | String | - | Название глоссария | - |
| desc | String | - | Описание глоссария | - |
| targetLang | String | - | Целевой язык | - |
| keys | String[] | - | Список исходных терминов | - |
| translated | JSON | - | 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.