# CMS — API

# PublicAPI

<p class="callout info">PublicAPI предназначен для взаимодействия с серверной частью Адвантедж. Через него внешняя система может получать статистику и работать с объектами личного кабинета.</p>

---

### Получите доступ

<span style="white-space:pre-wrap;">Для получения документации и ключа отправьте запрос в техническую поддержку по адресу </span>`<span class="editor-theme-code">support@goadvantage.ru</span>`. В запросе укажите организацию, платформу, планируемый сценарий и список требуемых операций.

Храните ключ на серверной стороне и не добавляйте его в клиентский код или публичный репозиторий.

---

### Статистика

PublicAPI позволяет получать:

- данные о посетителях, визитах и контактах;
- статистику показов контента.

![Пример методов статистики посетителей](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/vtQtMK3LrRxu.png)

![Пример методов статистики показов](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/pUdi1dsV4IA0.png)

---

### Устройства и каталоги

Доступны получение, создание, обновление и удаление устройств, а также получение и создание каталогов устройств.

![Пример методов устройств](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/Td3SANBIzGW3.png)

![Пример методов каталогов устройств](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/2tico2pzlcpD.png)

---

### Объекты платформы

Через API можно получать сведения о кампаниях, контенте, тегах устройств и профилях.

![Пример методов кампаний](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/nqEq5dsloaPH.png)

![Пример методов контента](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/Vv5kBIKmJ6xW.png)

![Пример методов тегов устройств](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/vdfobVfb7QT8.png)

![Пример методов профилей](https://secure.usedesk.ru/upload/gimages/168944/2025_07_07/TZgGhSOCywqf.png)

---

### Перед рабочим запуском

Проверьте права ключа, обработку пагинации и ошибок, повтор запросов, ограничения частоты и журналирование. Начинайте с чтения данных и только после проверки добавляйте изменяющие операции.