9.1. 🇺🇦 Огляд Server API

Про Gravitec API

Наш API - це REST API, який підтримує коди помилок HTTP для позначення помилок API і використовує базову HTTP-аутентифікацію для аутентифікації облікового запису користувача. Всі запити повинні бути у форматі JSON, ми не підтримуємо інші формати. Однак, ми відкрита команда, і ми відкриті для будь-яких пропозицій щодо форматів або логіки API. Будь ласка, напишіть нам на [email protected], якщо у вас є якісь пропозиції або проблеми з API.

На додаток до REST API ми надаємо нашим клієнтам Web SDK API, який по суті є JavaScript API, призначеним для управління базою даних ваших підписників. Наприклад, цей SDK надає функції для створення TAGS (мітки) та встановлення ALIASES (псевдонімів) для ваших підписників. Ці теги та аліаси можуть бути корисними для маркетингових цілей, таких як сегментація бази даних підписників за їхньою поведінкою, за їхніми вподобаннями або за багатьма іншими сценаріями, які ви реалізуєте.

Аутентифікація

Під час використання API необхідно автентифікувати свій обліковий запис, вказавши в запиті ключі APP KEY і APP SECRET. Ви можете знайти свої ключі APP на сторінці налаштувань сайту. Докладніше тут - 1.3.3. 🇺🇦 Дані REST API

⚠ Ваш APP KEY дозволяє надсилати push-повідомлення всім вашим підписникам, тому будьте обережні і зберігайте його в таємниці!

Аутентифікація до APP здійснюється за допомогою HTTP Basic Auth:

Вкажіть ваш application key ("APP_KEY") в якості основного AUTH username value
Вкажіть ваш application secret ("APP_SECRET") в якості основного AUTH password value
Всі запити API повинні бути зроблені через HTTPS. Calls, зроблені через звичайний HTTP, не будуть виконані. Запити API без автентифікації також не будуть виконані.

Приклад коду**:**

// via shell
// example APP_KEY = 1e26f7bb3f81e1ab789d3e20b9cf6325
// example APP_SECRET = 9bb59fcbff38b85647c421c65cca06ce
curl -X \\
  -u "1e26f7bb3f81e1ab789d3e20b9cf6325:9bb59fcbff38b85647c421c65cca06ce" \\
  -H "Content-Type: application/json" \\
  <https://uapi.gravitec.net/api/v3/push>

// or
curl -X \\
  -u "1e26f7bb3f81e1ab789d3e20b9cf6325:9bb59fcbff38b85647c421c65cca06ce" \\
  -H "Content-Type: application/json" \\
  <https://uapi.gravitec.net/api/v3/push>