Перейти до змісту

API для розробників

API для розробників Joystick дозволяє програмно отримувати доступ та змінювати ресурси та налаштування конфігурації Продукту, включаючи будь-які середовища, веб-хуки, схеми, конфігурації та інше, що є частиною Продукту. Це забезпечує потужну автоматизацію, робочі процеси та інтеграції.

Початок роботи

  1. Запит на доступ. Зверніться до нашої команди, щоб активувати доступ до API для розробників для вашої організації.
  2. Створіть ключ API Продукту.
  3. Використовуйте API для розробників!

Приклади функціональності

Багато функцій, які зазвичай потрібно виконувати через CMS Joystick, тепер доступні через API.

  • Створення нової конфігурації.
  • Оновлення конфігурації.
  • Синхронізація конфігурацій між середовищами.
  • Створення запитів на перенесення конфігурацій між середовищами.
  • Перегляд конфігурацій у декількох середовищах.

Управління ключами API

Для використання API для розробників потрібен ключ API Продукту. Ключ API Продукту матиме доступ лише до всіх сутностей, що належать цьому Продукту в Joystick. Користувачі повинні мати дозвіл 'Редактор' або 'Власник' для організації, щоб керувати ключами API Продукту.

Перейдіть до перегляду Продукту. Натисніть "Налаштування продукту" у верхньому правому куті.

Натисніть Управління ключами API Продукту

Рівні доступу

Рівень доступу Опис
Тільки читання Доступ до більшості GET-ендпоінтів.
Базовий доступ Можливість створювати, оновлювати, архівувати конфігурації, синхронізувати конфігурації, створювати запити на перенесення. Немає можливості змінювати, видаляти чи архівувати інші сутності.
Повний доступ Повний контроль над усіма сутностями, включаючи можливість видалення та архівування.

Потрібна допомога?

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

Використання API

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

Запит

Ендпоінти

METHOD https://capi.getjoystick.com/...
Повний список ендпоінтів можна знайти тут: https://capi.getjoystick.com/developer-api.

Заголовок

Заголовок Значення Обов'язково Примітки
x-product-api-key Ваш ключ API Продукту Так Ключ API, створений для ПРОДУКТУ, на який ви націлюєтесь. Це НЕ той самий ключ API, який використовується для отримання конфігурації.

Усунення несправностей

Виникли проблеми? Будь ласка, зверніться до нашої команди у Discord з будь-якими питаннями чи запитами.

Примітки

Використання API та безпека

  • Запити з ключем API Продукту враховуються як потрійні щодо вашого використання API.
  • Ключі API Продукту несуть ризики, включаючи повне видалення ваших даних. Будь ласка, захищайте та обережно використовуйте ваші ключі API Продукту.
  • НЕ створюйте ключі, особливо ключі Повного доступу, якщо ви не впевнені, що вони вам потрібні.
  • Ця функція може змінюватися.