> For the complete documentation index, see [llms.txt](https://ytimes-2.gitbook.io/ytimes-kafe/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ytimes-2.gitbook.io/ytimes-kafe/integracii/vneshnii-api.md).

# Внешний API

позволяет настроить интеграцию с программой

{% hint style="info" %}
Уточнения по API можно задать на специальный адрес <api@ytimes.ru>
{% endhint %}

Все методы работают на уровне торговой точки. Торговых точек в аккаунте может быть несколько, поэтому предварительно нужно будет получить список торговых точек, чтобы узнать guid (идентификатор) нужной торговой точки. Далее его нужно будет передавать в методы API, чтобы получить данные этой точки.

### Начало работы с API

Активировать работу по API нужно в аккаунте на странице "**Настройки - Интеграции**". Создать интеграцию с типом "**Интеграция по API**", указав права на созданную интеграцию.

URL для обращений к API:&#x20;

```http
https://api.ytimes.ru/ex/
```

В заголовок запросов **Authorization** необходимо передавать ключ авторизации. Ключ авторизации скопировать в настройках интеграции, созданной на странице: **Настройки - Интеграции**.&#x20;

Дополнительные требуемые заголовки:

```http
Accept: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8
```

В запросах и ответах используется JSON. Стандартный формат ответа:

```javascript
{
   "success":true/false, 
   "count": data size, 
   "rows": some data,
   "error": error description
}
```