> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Інтеграція та використання Localization Translate API

> Localization translation 集成指南 - XHuoAPI

Основна функція Localization Translate API полягає в отриманні перекладеного тексту шляхом введення тексту, що потребує перекладу, при цьому мову перекладу можна налаштувати, а результати перекладу можуть бути виведені у двох основних форматах: `json` та `markdown`.

Цей документ детально описує інструкції з інтеграції Translate API, щоб допомогти вам легко інтегрувати та повністю використовувати потужні можливості цього API. За допомогою Translate API ви можете легко реалізувати переклад введеного тексту на певну мову, а також підтримувати специфічні способи виведення результатів перекладу.

## Процес подачі заявки

Щоб використовувати Localization Translate API, спочатку потрібно перейти на сторінку подачі заявки [Localization Translate API](https://api.xhuoapi.ai/documents/6dcc60d0-a973-4ad2-92d8-11f4d3775532) для отримання відповідної послуги. Після переходу на сторінку натисніть кнопку «Acquire», як показано на малюнку:

![Сторінка подачі заявки](https://cdn.xhuoapi.ai/rci31i.png)

Якщо ви ще не увійшли в систему або не зареєстровані, вас автоматично перенаправлять на [сторінку входу](https://api.xhuoapi.ai), щоб запросити реєстрацію та вхід. Після входу або реєстрації ви автоматично повернетеся на поточну сторінку.

При першій подачі заявки вам буде надано безкоштовний ліміт, який дозволяє безкоштовно використовувати цей API.

## Приклад запиту

Розглянемо приклад з англійським введенням, щоб продемонструвати, як використовувати цей API. Припустимо, англійський опис виглядає так: `# Title 1\n\nThis is a paragraph.\n\n## Title 2\n\nThis is another paragraph.`, далі продемонструємо, як завантажити англійський опис і отримати переклад на китайську мову, при цьому виводячи його у форматі markdown.

### Налаштування заголовків запиту та тіла запиту

**Request Headers** включає:

* `accept`: вказує на прийняття відповіді у форматі JSON, тут вказується `application/json`.
* `authorization`: ключ для виклику API, після подачі заявки можна вибрати з випадаючого списку.

**Request Body** включає:

* `input`: текст, що потребує перекладу.
* `locale`: налаштування мови перекладу.
* `extension`: налаштування формату виведення результату перекладу.
* `model`: велика модель, що використовується для перекладу, за замовчуванням gpt-3.5.

Налаштування виглядає так, як показано на малюнку:

<p>
  <img src="https://cdn.xhuoapi.ai/d4uqst.png" width="500" className="m-auto" />
</p>

### Приклад коду

Можна помітити, що на правій стороні сторінки автоматично згенеровано код на різних мовах, як показано на малюнку:

<p>
  <img src="https://cdn.xhuoapi.ai/tn5nno.png" width="500" className="m-auto" />
</p>

Деякі приклади коду наведені нижче:

#### CURL

```bash theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/localization/translate' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "input": "# Title 1\n\nThis is a paragraph.\n\n## Title 2\n\nThis is another paragraph.",
  "locale": "zh-CN",
  "extension": "md"
}'
```

#### Python

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/localization/translate"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "input": "# Title 1\n\nThis is a paragraph.\n\n## Title 2\n\nThis is another paragraph.",
    "locale": "zh-CN",
    "extension": "md"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

### Приклад відповіді

Після успішного запиту API поверне інформацію про результати цього перекладного завдання. Наприклад:

```json theme={null}
{
  "data": "# 标题 1\n\n这是一个段落。\n\n## 标题 2\n\n这是另一个段落。",
  "usage": {
    "prompt_tokens": 172,
    "completion_tokens": 25
  },
  "model": "gpt-3.5-turbo-16k",
  "locale": "zh-CN"
}
```

Як видно, у результаті є поле `data`, яке містить перекладений текст китайською мовою, при цьому повертається у форматі markdown, інша інформація виглядає наступним чином:

* `data`, результат цього перекладного завдання.
* `model`, велика мовна модель, що використовується для цього перекладного завдання.
* `locale`, тип мови перекладу для цього перекладного завдання.

## Обробка помилок

При виклику API, якщо виникає помилка, API поверне відповідний код помилки та інформацію. Наприклад:

* `400 token_mismatched`: Неправильний запит, можливо, через відсутні або недійсні параметри.
* `400 api_not_implemented`: Неправильний запит, можливо, через відсутні або недійсні параметри.
* `401 invalid_token`: Неавторизовано, недійсний або відсутній токен авторизації.
* `429 too_many_requests`: Занадто багато запитів, ви перевищили ліміт запитів.
* `500 api_error`: Внутрішня помилка сервера, щось пішло не так на сервері.

### Приклад помилки у відповіді

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Висновок

Завдяки цьому документу ви дізналися, як використовувати Localization Translate API для легкого перекладу введеного тексту на певну мову, а також підтримувати специфічні способи виведення результатів перекладу. Сподіваємося, що цей документ допоможе вам краще інтегрувати та використовувати цей API. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої команди технічної підтримки.
