REST JSON API для статистики, відгуків, рейтингів і телефонів

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

Один ключ, чотири ендпоінти

API версіонується під /api/v1, і кожен ендпоінт говорить чистим JSON. Спрямуйте свій клієнт на потрібний ресурс:

• GET /api/v1/stats — аналітика для сайту, яким ви володієте: відвідувачі, перегляди сторінок, топові сторінки, джерела та країни.
• GET /api/v1/reviews — відгуки разом із рейтингом об'єкта.
• GET /api/v1/rating — зведення за рейтингом із розподілом зірок.
• GET /api/v1/phone — інформація про телефонні номери.

Крім того, Auth API забезпечує роботу «Входу через Astrina», тож ви можете додати соціальний вхід до власного застосунку, не вибудовуючи систему ідентифікації самостійно.

Автентифікація так, як зручно вашому стеку

Отримайте ключ на /my/api.php, а потім надсилайте його тим способом, який найзручніший для вашого клієнта. API приймає три форми:

• Заголовок X-Api-Key.
• Токен Authorization: Bearer.
• Параметр запиту ?api_key=.

Автентифікація через заголовок — найбезпечніший варіант за замовчуванням для серверного коду; параметр запиту зручний для швидких тестів і викликів на боці браузера. Відповіді відкриті для CORS, тож за потреби ви можете викликати API безпосередньо з фронтенду, і вони позначені як noindex, щоб ваші дані не потрапили до пошукових систем.

Квоти та тарифи

Використання обліковується щодня, і кожна відповідь повідомляє вам, де ви перебуваєте — кожна відповідь містить дані про витрату вашої квоти, тож вам ніколи не доведеться гадати, скільки викликів у вас залишилося.

• Безкоштовний тариф: 100 викликів на день.
• Тариф API: 10 000 викликів на день за €19 за 30 днів.
• Тариф бізнес-аналітики: доступ до API включено.

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

Передбачуваний JSON, передбачувані помилки

І успіх, і збій повертаються у вигляді JSON. Коли щось іде не так, у відповіді є поле error і правильний HTTP-статус, тож ваша обробка помилок може розгалужуватися за кодом статусу, а не розбирати рядки:

• 401 — невірний ключ.
• 429 — квоту перевищено.
• 400 / 422 — невірні параметри.

Оскільки стан квоти надходить у кожній відповіді, коректно написаний клієнт може знизити навантаження ще до того, як взагалі побачить 429.

Як почати

1. Відкрийте /my/api.php і створіть ключ API.
2. Виберіть ендпоінт — почніть із /api/v1/stats для сайту, яким ви володієте.
3. Надішліть ключ у заголовку X-Api-Key і зчитайте JSON у відповідь.

Перший виклик — це один рядок:

curl -H "X-Api-Key: YOUR_KEY" https://astrina.io/api/v1/stats

Віддаєте перевагу bearer-токену? Замініть заголовок:

curl -H "Authorization: Bearer YOUR_KEY" https://astrina.io/api/v1/reviews

Або вставте ключ прямо в URL для швидкої перевірки:

curl "https://astrina.io/api/v1/rating?api_key=YOUR_KEY"

Далі той самий патерн охоплює рейтинги та інформацію про телефонні номери — один ключ, один заголовок, чотири джерела даних. Отримайте свій ключ і зробіть перший виклик уже сьогодні.