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

# Огляд Ayrshare API

> Потужні соціальні API, які дозволяють без зусиль надсилати пости в соцмережі та отримувати аналітику. Для розробників і бізнесу будь-якого масштабу.

Social Media REST API надає розробникам програмний доступ до кількох соцмереж через єдиний уніфікований інтерфейс.
За допомогою соціального API Ayrshare ви можете керувати активністю в соцмережах — створювати й видаляти пости, отримувати аналітику, взаємодіяти з коментарями та відгуками, керувати прямими повідомленнями, створювати рекламу Facebook та виконувати інші соціальні дії на різних платформах.

Наразі API підтримує 13 основних соцмереж: Bluesky, Facebook, Google Business Profile, Instagram, LinkedIn, Pinterest, Reddit, Snapchat, Telegram, Threads, TikTok, X (раніше Twitter) та YouTube.
Інтегрувавшись із цим API, розробники можуть автоматизувати завдання керування соцмережами одночасно на всіх цих платформах.

Дані запитів і відповідей API — у форматі JSON, що дозволяє легко парсити й обробляти їх у більшості мов програмування.

Якщо ви на плані Launch, Business або Enterprise, див. [Business Plan Overview](/multiple-users/business-plan-overview), [Launch Plan Overview](/multiple-users/business-launch-overview) та [ендпоінт /profiles](/apis/profiles/overview).

## Ключова функціональність

<ul class="custom-bullets">
  <li>[Підтримка 13 соцмереж](/introduction#which-social-networks-are-supported).</li>
  <li>Захищений доступ до API за вашим унікальним API Key.</li>
  <li>Заплановані публікації у підключених соцмережах.</li>
  <li>Автоматична публікація за наперед визначеним розкладом.</li>
  <li>Підтримка зображень та відеоконтенту, включно з Reels, Stories та Spotlight.</li>
  <li>Видалення постів у підключених соцмережах.</li>
  <li>Комплексна аналітика залученості (лайки, поширення тощо).</li>
  <li>Метрики соціальних акаунтів, включно з кількістю підписників та демографічними даними.</li>
  <li>Керування коментарями: перегляд, додавання та видалення коментарів до постів.</li>
  <li>Опціональне скорочення посилань для всіх або конкретних URL у постах.</li>
  <li>Інтеграція з Unsplash: додавайте конкретні зображення або обирайте випадкові за ключовими словами.</li>
  <li>Опція автоматичної генерації хештегів на основі релевантних ключових слів.</li>
  <li>Відстеження історії постів, включно з постами, зробленими не через Ayrshare.</li>
  <li>Керування відгуками: отримання, відповіді та видалення відповідей на відгуки.</li>
  <li>Інтеграція RSS-стрічок для автоматизованої публікації контенту.</li>
  <li>Медіабібліотека: завантаження та зберігання фото й відео для використання у постах.</li>
  <li>[Social Post Verification System](/testing/post-verification) для безпеки ваших соціальних акаунтів.</li>
</ul>

## Business Plan та Launch Plan

Можливості [Business Plan](/multiple-users/business-plan-overview) та [Launch Plan](/multiple-users/business-launch-overview) для керування кількома користувачами та клієнтами:

<ul class="custom-bullets">
  <li>Дозвольте користувачам підключати власні акаунти соцмереж до вашої платформи.</li>
  <li>Захищений єдиний вхід через OAuth для швидкого підключення акаунтів.</li>
  <li>Створюйте та видаляйте User Profiles програмно через API.</li>
  <li>Доступ до розширеної аналітики користувачів.</li>
  <li>Підтримка webhooks для оновлень у реальному часі.</li>
  <li>Керування прямими повідомленнями на підтримуваних платформах.</li>
  <li>Створення реклами Facebook з наявних постів.</li>
</ul>

Зв'яжіться з нами, щоб дізнатися більше про [Business Plan](https://www.ayrshare.com/business-plan-for-multiple-users/).

## Ads API

[Ads API](/apis/ads/overview) дозволяє створювати рекламу Facebook з наявних постів.

<ul class="custom-bullets">
  <li>Просування постів для охоплення більшої аудиторії.</li>
  <li>Керування рекламою та відстеження ефективності.</li>
  <li>Аналіз рекламних витрат та оптимізація кампаній.</li>
</ul>

<Card title="Ads API" icon="code" href="/apis/ads/overview" horizontal>
  Досліджуйте Ads API
</Card>

## Messages API

Уніфікований [Messaging API](/apis/messages/overview) для залучення користувачів у розмови на основних соціальних каналах: Facebook, Instagram та X.

<ul class="custom-bullets">
  <li>Надсилання текстових, графічних та відеоповідомлень.</li>
  <li>Отримання повних історій розмов.</li>
  <li>Налаштування автоматичних відповідей на повідомлення.</li>

  <li>
    Отримання оновлень у реальному часі через webhooks про отримані повідомлення, реакції на повідомлення та
    підтвердження прочитання.
  </li>
</ul>

Цей API спрощує залучення користувачів, централізуючи операції з повідомленнями для кількох соціальних каналів. Дізнатися більше…

<Card title="Messages API" icon="code" href="/apis/messages/overview" horizontal>
  Досліджуйте уніфікований messaging API
</Card>

## Max Pack

Отримайте ще більше можливостей із додатком [Max Pack](/additional/maxpack):

<Card title="Max Pack" icon="link" href="/additional/maxpack" horizontal>
  Розблокуйте розширені функції — генерацію контенту на базі AI, поглиблену аналітику та розширену
  підтримку платформ — з додатком Max Pack.
</Card>

## Дивіться, як користуватися Social API

Якщо ви розробляєте на Node.js, перегляньте це відео про підключення та публікацію постів у X та Facebook.

<div class="video-container">
  <iframe width="560" height="315" src="https://www.youtube.com/embed/OMtj2h6sW6U" title="How to Use Ayrshare's Social API" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" />
</div>

## Демо Social API

Якщо ви користуєтеся Node.js, перегляньте демо-код Social API, щоб почати створювати власну інтеграцію.

<Card title="Social API Demo" icon="github" href="https://github.com/ayrshare/social-api-demo" horizontal>
  Досліджуйте наш демо-код на Node.js, щоб швидко розпочати інтеграцію Social API
</Card>

## Базовий URL

Базовий URL для Ayrshare API однаковий для всіх ендпоінтів.

`https://api.ayrshare.com/api`

## Authorization

Ayrshare автентифікує запити API за допомогою токена Authorization, що передається в HTTP-заголовку. Обов'язково надсилайте `Bearer` разом із API Key. API Key можна знайти в Ayrshare Dashboard, перемкнувшись на Primary Profile.

Якщо ви користувач Business або Enterprise, можете створювати User Profiles з Profile Keys для керування кількома клієнтами. Profile Key використовується у заголовку ваших запитів.
API Key також має бути у заголовку запитів для User Profiles.

<Tip>
  На планах Premium у заголовку запитів має використовуватися лише API Key. На планах Business та Enterprise
  у заголовку запитів слід використовувати Profile Key, коли ви взаємодієте від імені
  User Profile.
</Tip>

### Формат API Key

`Authorization: Bearer API_KEY` — замініть API\_KEY на API Key вашого Primary Profile, який можна [знайти в Ayrshare Dashboard](/quickstart#get-your-api-key).

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {"Authorization": "Bearer API_KEY"}
  ```

  ```python Python theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```php PHP theme={"system"}
  $headers = ["Authorization" => "Bearer API_KEY"];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{"Authorization": "Bearer API_KEY"}
  ```

  ```ruby Ruby theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```java Java theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```csharp C# theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```rust Rust theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```
</CodeGroup>

<Note>
  Отримайте секретний API Key на дашборді Ayrshare на сторінці API Key у лівій навігаційній панелі.

  Наприклад, якщо ваш API Key — 2MPXPKQ-S03M5LS-GR5RX5G-AZCK8EA

  Ваш заголовок має включати:

  `Authorization: Bearer 2MPXPKQ-S03M5LS-GR5RX5G-AZCK8EA`
</Note>

### Формат Profile Key

Profile Key використовується для взаємодії від імені User Profile.
Доступний лише на планах Business або Enterprise.

`Profile-Key: PROFILE_KEY` — замініть PROFILE\_KEY на [Profile Key](/multiple-users/manage-user-profiles#get-the-profile-key) користувача.

**Включення Profile Key у заголовок необхідне для взаємодії від імені User Profile**.

Відсутність API Key Primary Profile або використання Profile Key замість API Key у заголовку призведе до помилки.

Ось як структурувати заголовки для API-запитів:

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \ 
       -H "Profile-Key: PROFILE_KEY" \
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```python Python theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```php PHP theme={"system"}
  $headers = [
    "Authorization" => "Bearer API_KEY",
    "Profile-Key" => "PROFILE_KEY"
  ];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```ruby Ruby theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```java Java theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```csharp C# theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```rust Rust theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```
</CodeGroup>

<Note>
  [Знайдіть Profile Key](/multiple-users/manage-user-profiles#get-the-profile-key) в Ayrshare Dashboard на сторінці Profile Key у лівій навігаційній панелі.
  Перемкніться на профіль, який хочете використовувати, на сторінці User Profile.
  Крім того, Profile Key повертається у відповіді ендпоінта [Create a User Profile](/apis/profiles/create-profile).

  Далі можна використовувати Profile Key у заголовку запитів:

  Наприклад, якщо ваш Profile Key — `AX1XGG-9jK3M5LS-GR5RX5G-LLCK8EA`

  Ваш заголовок має містити і API, і Profile Key:

  `Authorization: Bearer 2MPXPKQ-S03M5LS-GR5RX5G-AZCK8EA`

  `Profile-Key: AX1XGG-9jK3M5LS-GR5RX5G-LLCK8EA`
</Note>

### X/Twitter BYO Credentials

З 31 березня 2026 року всі операції X/Twitter через Ayrshare потребують ваших власних OAuth 1.0a-облікових даних. Після підключення X-акаунта через OAuth передавайте ці 2 заголовки разом з `Authorization` (та опціональним `Profile-Key`) для будь-якого запиту, спрямованого на X/Twitter:

| Заголовок                     | Опис                                            |
| ----------------------------- | ----------------------------------------------- |
| `X-Twitter-OAuth1-Api-Key`    | Ваш OAuth 1.0a API Key (Consumer Key)           |
| `X-Twitter-OAuth1-Api-Secret` | Ваш OAuth 1.0a API Key Secret (Consumer Secret) |

Ці заголовки обов'язкові після 31 березня 2026 року. Запити до ендпоінтів X/Twitter без валідних BYO-облікових даних будуть відхилені.

<Info>
  **Одна пара ключів для кожного запиту.** Ви створюєте один X Developer App на акаунт Ayrshare і використовуєте однакові значення `X-Twitter-OAuth1-Api-Key` та `X-Twitter-OAuth1-Api-Secret` у кожному запиті до X, незалежно від того, для якого субпрофіля (`Profile-Key`) призначено запит. Ключі не генеруються й не ротуються для кожного клієнта чи кінцевого користувача.
</Info>

Див. [Посібник із налаштування X BYO Key](/dashboard/connect-social-accounts/x-twitter-byo-keys) з покроковими інструкціями, прикладами коду та порадами з усунення несправностей.

Ті ж два заголовки застосовуються при керуванні X/Twitter через [MCP Server](/additional/mcp-action-server) — див. [Connect & Setup](/additional/mcp-action-connect).

## Content Type

Content Type завжди має бути `Content-Type: "application/json"`, якщо ендпоінт спеціально не вказує інакше.

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \ 
       -H "Profile-Key: PROFILE_KEY" \ # Optional
       -H "Content-Type: application/json" \
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```python Python theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json"
  }
  ```

  ```php PHP theme={"system"}
  $headers = [
    "Authorization" => "Bearer API_KEY",
    "Profile-Key" => "PROFILE_KEY", # Optional
    "Content-Type" => "application/json"
  ];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```ruby Ruby theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json"
  }
  ```

  ```java Java theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```csharp C# theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```rust Rust theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```
</CodeGroup>

## Стиснення

Ayrshare підтримує стиснення для всіх API-запитів.
Щоб увімкнути стиснення, встановіть заголовок `Accept-Encoding` у `deflate, gzip, br`.

```bash theme={"system"}
  Accept-Encoding: "deflate, gzip, br"
```

Рекомендується для викликів з великими відповідями, наприклад [ендпоінта /history](/apis/history/overview).

<ul class="custom-bullets">
  <li>Стискаються лише відповіді, більші за 1024 байти (1KB).</li>

  <li>
    Порядок стиснення: спочатку Brotli (br), потім gzip, потім deflate. Brotli — найефективніший
    алгоритм стиснення.
  </li>

  <li>
    Заголовок відповіді містить використане кодування контенту. Наприклад: `content-encoding: br`, якщо
    використано Brotli.
  </li>

  <li>
    Дізнайтеся більше про стиснення та його переваги у [блозі
    Ayrshare](https://www.ayrshare.com/blog/http-compression-in-node-js-a-dive-into-gzip-deflate-and-brotli/).
  </li>
</ul>

<Tip>Не забудьте коректно розпакувати відповідь, використовуючи вказане кодування.</Tip>

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \ 
       -H "Profile-Key: PROFILE_KEY" \ # Optional
       -H "Content-Type: application/json" \
       -H "Accept-Encoding: deflate, gzip, br" \ 
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```python Python theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```php PHP theme={"system"}
  $headers = [
    "Authorization" => "Bearer API_KEY",
    "Profile-Key" => "PROFILE_KEY", # Optional
    "Content-Type" => "application/json",
    "Accept-Encoding" => "deflate, gzip, br"
  ];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```ruby Ruby theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```java Java theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```csharp C# theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```rust Rust theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```
</CodeGroup>

## Типи ID

Існує кілька типів ID, які повертаються та можуть використовуватися в різних ендпоінтах:

### Ayrshare Post ID

Цей ID генерує Ayrshare, і він повертається з
[ендпоінта /post](/apis/post/post) у полі `id`. З цим ID легко
отримати аналітику посту в різних соцмережах, додавати коментарі до
посту, видаляти пост тощо. Це ID, який ви будете використовувати найчастіше.

### Social Post ID

Кожна соцмережа присвоює власний унікальний ID постам і коментарям.
Ці ID повертаються у полі `postIds` ендпоінтів /post або /comments.
Ви можете використовувати ці ID (або отримані безпосередньо із соцмереж) для отримання даних — наприклад, у [analytics social post ID](/apis/analytics/social-by-id).

### Ayrshare Comment ID

Цей ID генерує Ayrshare, і він повертається з
[ендпоінта /comments](/apis/comments/post-comment) у полі `id`. З цим ID легко
отримати аналітику коментаря в різних соцмережах, додавати відповіді до
коментаря, видаляти коментар тощо. Це ID, який ви будете використовувати найчастіше.

Часто застосовується, коли потрібні деталі конкретного коментаря, опублікованого через Ayrshare.

### Social Comment ID

Кожна соцмережа присвоює власний унікальний ID коментарям.
Ці ID повертаються у полі `commentId` [ендпоінта GET /comments](/apis/comments/get-comments).

Часто застосовується, коли потрібні деталі конкретного коментаря, опублікованого поза межами Ayrshare.

## Коди помилок

Помилки повертаються зі [стандартними HTTP-кодами статусу](https://tools.ietf.org/html/rfc2616#section-10).

Докладніше:

<Card title="HTTP Status Codes" icon="link" horizontal href="/errors/errors-http">
  Дізнайтеся більше про HTTP-коди статусу
</Card>

Детальні помилки містяться у відповіді REST API — специфічні для кожного типу виклику.

Докладніше:

<Card title="Ayrshare Error Codes" icon="link" horizontal href="/errors/errors-ayrshare">
  Дізнайтеся більше про специфічні коди помилок Ayrshare
</Card>

## Формат часової мітки

Ayrshare використовує Zulu Time, також відомий як UTC (Coordinated Universal Time), або ISO 8601-форматований рядок дати для точних і однозначних посилань на час у різних часових поясах.

Наприклад, використовуйте формат `YYYY-MM-DDThh:mm:ssZ` і надсилайте як `2026-07-08T12:30:00Z`.
Більше прикладів див. на [utctime](https://www.utctime.net/).

Ви можете конвертувати UTC у місцевий час мовою програмування на ваш вибір. Наприклад, у JavaScript:

```javascript theme={"system"}
const convertToLocalTime = (isoString) => {
  // Create a new Date object from the ISO string
  const date = new Date(isoString);

  // Extract local time components
  const localDate = date.toLocaleDateString();
  const localTime = date.toLocaleTimeString();

  // Combine the local date and time
  const localDateTime = `${localDate} ${localTime}`;

  return localDateTime;
};
```

## Postman

Ви можете використовувати Postman для тестування ваших REST API-викликів.

<Card title="Postman" icon="link" horizontal href="/testing/postman">
  Дізнайтеся, як використовувати Postman з нашим API
</Card>

## Випадкові пости, зображення та відео

Перегляньте [посібник швидкого старту](/quickstart#publish-test-posts) про те, як надсилати випадкові пости, зображення або відео під час тестування.

## Пакети

У нас є пакети Node.js і Python, а також посібники для Bubble.io, Airtable та Make, які спрощують виклики RESTful.

<CardGroup cols={2}>
  <Card title="Node NPM Package" icon="cube" iconType="duotone" href="/packages-guides/nodejs" horizontal>
    Інтегруйтеся з нашим пакетом NodeJS
  </Card>

  <Card title="Python PyPI Package" icon="cube" iconType="duotone" href="/packages-guides/python" horizontal>
    Інтегруйтеся з нашим пакетом Python
  </Card>

  <Card title="Airtable Guide" icon="book-open" iconType="duotone" href="/packages-guides/airtable" horizontal>
    Дізнайтеся, як використовувати Ayrshare з Airtable
  </Card>

  <Card title="Bubble Plugin & Guide" icon="cube" iconType="duotone" href="/packages-guides/bubble" horizontal>
    Дізнайтеся, як використовувати Ayrshare з Bubble.io
  </Card>

  <Card title="Make Guide" icon="book-open" iconType="duotone" href="/packages-guides/make" horizontal>
    Дізнайтеся, як використовувати Ayrshare з Make
  </Card>

  <Card title="Notion Guide" icon="book-open" iconType="duotone" href="/packages-guides/notion" horizontal>
    Дізнайтеся, як використовувати Ayrshare з Notion
  </Card>

  <Card title="FlutterFlow Guide" icon="book-open" iconType="duotone" href="/packages-guides/flutterflow" horizontal>
    Дізнайтеся, як використовувати Ayrshare з FlutterFlow
  </Card>

  <Card title="Retool Guide" icon="book-open" iconType="duotone" href="/packages-guides/retool" horizontal>
    Дізнайтеся, як використовувати Ayrshare з Retool
  </Card>
</CardGroup>