У налаштуваннях Для розробників ви підключаєте Exayard до власного коду та до застосунків, які створюють інші компанії. Відкрийте Налаштування, а потім Для розробників. Цей пункт у меню налаштувань бачать лише адміністратори компанії. Учасник, який відкриє сторінку, може її переглядати, але нічого не може змінити.

Застосунки, ключі API, вебхуки та журнали доступні в кожному тарифному плані, зокрема в безкоштовному. Оплачується лише робота ШІ.

Застосунок це одна з ваших інтеграцій, наприклад "Acme estimator" або "Nightly sync". Кожен ключ API належить певному застосунку. Розділ Застосунки розташований першим на сторінці. Його можуть переглядати всі учасники. Створювати та змінювати застосунки можуть лише адміністратори.

Натисніть Новий застосунок і заповніть поля Назва, Опис, Головна сторінка, Електронна пошта підтримки та Області доступу. Області доступу поділяються на читання й запис для кожного ресурсу, наприклад read:projects і write:estimates. Застосунки не можуть запитувати область admin:org. Компанія може мати до 25 застосунків.

Для кожного застосунку відображається дата створення та ліміт запитів, наприклад "До 60 запитів на хвилину для кожної компанії та 600 загалом". Меню Інші дії застосунку містить:

Ключ API дає змогу вашому власному коду викликати API Exayard. Ключі зберігаються всередині застосунку, у розділі Ключі. Ключ працює в компанії свого застосунку, тому передавати ідентифікатор компанії не потрібно.

Щоб створити ключ, натисніть Новий ключ у застосунку. Укажіть Назву ключа, наприклад "Production". У полі Області доступу виберіть Усі, щоб надати всі області доступу застосунку, або Вибрані, щоб вибрати менше. За бажанням установіть дату в полі Термін дії, якщо ключ потрібен для короткочасної роботи. Ключ діє до кінця цього дня. Натисніть Створити.

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

Ключ починається з exa_live_. Ключ, створений у пісочниці, починається з exa_test_. Після створення для ключа відображаються його назва, фрагмент на зразок exa_live_...AbCd, а також Останнє використання або Не використовувався. Для ключа з обмеженим строком відображається Термін дії і дата, а для простроченого ключа відображається Термін дії минув.

Застосунок може мати до 25 активних ключів. Прострочений ключ враховується, доки ви його не відкличете. Щоб замінити ключі без перерви в роботі, створіть другий ключ, переведіть на нього свої сервери, а потім відкличте перший.

Відкрийте меню Дії з ключем, щоб Перейменувати або Відкликати ключ. Відкликання не можна скасувати, і ключ перестає працювати протягом 30 секунд.

Якщо ключ опиняється у відкритому доступі, наприклад у публічному репозиторії коду, Exayard відкликає його, надсилає електронного листа вашим адміністраторам і залишає його в переліку з позначкою Знайдено у відкритому доступі, відкликано.

Коли інша компанія встановила ваш застосунок, у вікні створення ключа також відображається поле Діє в. За замовчуванням вибрано Ця компанія. Варіант Усі компанії, які його встановили створює ключ, який ваш сервер використовує в кожній із цих компаній. Тоді кожен виклик указує свою компанію в заголовку Exayard-Organization-Id.

Ті самі ключі підключають інструменти без коду. Див. Підключення Exayard до Zapier, Підключення Exayard до Make і Підключення Exayard до n8n. Про ШІ-асистентів див. Підключення Exa до вашого ШІ-асистента.

Ключі, створені до того, як ключі почали зберігатися в застосунках, починаються з ak_. Вони продовжують працювати, але нові такі ключі створювати не можна. Вони відображаються в розділі Старі ключі внизу сторінки, лише поки вони є.

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

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

Натисніть Нова пісочниця, укажіть Назву і натисніть Створити. Компанія може мати до 5 пісочниць. Кнопка Відкрити перемикає вас у пісочницю, де перемикач компаній позначає її як Пісочниця. Створіть там застосунок і ключ, як завжди. Її ключі починаються з exa_test_. Щоб перейти до роботи в реальному режимі, створіть такий самий застосунок і ключ у своїй справжній компанії та замініть ключ у своєму коді.

Пісочниця працює за тарифним планом вашої компанії, і ваша компанія оплачує її використання. Вона не має власних розрахунків і не отримує власного місячного обсягу використання ШІ. Вебхуки та інтеграції працюють так само, як у вашій справжній компанії.

Пісочниця не надсилає електронних листів із комерційними пропозиціями чи підписаних копій людям поза нею, а також не надсилає SMS. Такі повідомлення позначаються як "Не надіслано, оскільки ця компанія є пісочницею". Запрошення приєднатися до пісочниці надсилаються як завжди.

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

Щоб видалити пісочницю, натисніть Видалити в її рядку, а потім Видалити пісочницю. Пісочницю буде закрито, її ключі перестануть працювати, а її дані згодом буде стерто.

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

Натисніть Створити вебхук, введіть URL, на який надходитимуть доставки, і за бажанням додайте Опис. Виберіть, які Події надсилати. Виберіть Усі, щоб отримувати всі події, зокрема нові, або Вибрані, щоб вибрати зі списку. Усі події та їхній вміст наведено в каталозі подій вебхуків.

Коли ви створюєте вебхук, Exayard один раз показує його Секрет підпису. Скопіюйте його в цей момент, бо повторно він не відображатиметься.

Решта дій доступна в меню Інші дії вебхука:

Тестова подія та повторне надсилання виконуються один раз і ніколи не повторюються.

Кожна доставка містить заголовок Exayard-Signature у форматі t=<unix>,v1=<digest>. Exayard формує підпис, поєднуючи мітку часу й тіло запиту, а потім підписує їх за алгоритмом HMAC-SHA256 секретом вашого вебхука.

Кожна доставка також містить заголовки Exayard-Event-Id, Exayard-Event-Type і Exayard-Organization-Id. JSON-тіло має поле organizationId, яке вказує компанію, від якої надійшла подія. Заголовок містить той самий ідентифікатор, тож ви можете маршрутизувати доставку ще до читання тіла. Підпис охоплює все тіло, зокрема organizationId.

Оскільки кожна доставка вказує свою компанію, одна адреса-отримувач може обслуговувати багато компаній. Зареєструйте той самий URL у кожній компанії та маршрутизуйте кожну доставку за organizationId. Кожен вебхук має власний секрет, тому перед перевіркою вибирайте секрет за Exayard-Organization-Id.

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

Невдала доставка виконується загалом до 10 разів протягом приблизно 80 годин, зі збільшенням інтервалів між спробами. Кожна спроба надсилає те саме тіло й той самий ID події. Переспрямування вважається невдачею.

Ваш застосунок працює у вашій власній компанії одразу після створення. Кожен застосунок також має розділ Дозволити іншим компаніям встановлювати цей застосунок. У ньому відображається статус застосунку (Перевірено, Перевірку запитано або Не перевірено), його Адреси для входу, його ID клієнта і кількість компаній, які можуть його встановити.

Адміністратори відкривають меню Дії зі встановлення для таких дій:

Новий застосунок можна встановити щонайбільше у 25 компаніях, крім вашої, і він не з'являється в розділі Пошук застосунків. Компанії з розділу Облікові записи для ваших клієнтів не враховуються в цьому обмеженні. Після схвалення застосунок отримує позначку Перевірено, а обмеження на кількість встановлень знімається. Скористайтеся пунктом Показати в розділі «Пошук застосунків», щоб додати його до каталогу кожної компанії, або Приховати з розділу «Пошук застосунків», щоб прибрати його звідти. Застосунок зі статусом Заблоковано не може викликати Exayard, доки служба підтримки не зніме блокування, а його встановлення зберігаються.

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

Відкрийте меню Інші дії застосунку та натисніть Вебхук. Введіть URL і натисніть Створити, а потім скопіюйте Секрет підпису, який Exayard показує лише один раз. Кожна компанія, що встановила застосунок, надсилає події, які охоплюють надані нею області доступу. Ваш застосунок також отримує app.installed, app.scopes_approved і app.uninstalled, коли компанія встановлює його, схвалює ширший доступ або видаляє його. Доставки вказують свою компанію і підписуються так само, як інші вебхуки.

У тому самому діалоговому вікні можна Призупинити та Відновити доставки, а також скористатися діями Змінити секрет і Видалити вебхук.

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

У кожному рядку відображаються назва застосунку, позначка Перевірено (якщо застосунок перевірено), компанія, яка його створила, хто і коли його встановив, а також надані йому області доступу.

Відкрийте посилання для встановлення застосунку або натисніть Встановити поруч із ним у розділі Пошук застосунків. У діалоговому вікні відображається, хто створив застосунок, чи перевірено його, і які області доступу він запитує. Потім виберіть:

Натисніть Встановити. Якщо застосунок виконує вхід через Exayard, після цього Exayard переведе вас до завершення входу в застосунок. Якщо ви учасник, але не адміністратор, діалогове вікно повідомить, адміністратор якої компанії може його встановити. Натисніть Копіювати посилання, щоб надіслати його цьому адміністраторові.

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

Коли застосунок запитує додаткові області доступу, у його рядку відображається Запитує ширший доступ разом із новими областями. Щоб надати їх, адміністратор натискає Схвалити. Доти застосунок зберігає доступ, який мав раніше.

Відкрийте меню Інші дії застосунку, натисніть Видалити та підтвердьте. Застосунок одразу втрачає доступ до вашої компанії, а його вебхуки припиняють роботу. Робота ШІ, яку він уже розпочав, буде завершена.

Розділ Пошук застосунків розташований усередині розділу Підключені застосунки. У ньому перелічено перевірені застосунки, які їхні розробники вирішили опублікувати в каталозі. Застосунок, який у вашій компанії вже є, має позначку Встановлено. Натисніть Встановити біля будь-якого іншого застосунку, щоб відкрити вікно встановлення.

Розділ Ваші особисті підключення містить перелік ШІ-інструментів та інших застосунків, які ви підключили до свого власного облікового запису Exayard, наприклад ChatGPT або Claude. Він розташований угорі розділу Підключені застосунки, і свої підключення бачите лише ви. Особисте підключення діє від вашого імені, тому має доступ до всього, до чого маєте доступ ви.

Для кожного підключення відображається, коли його було використано вперше та востаннє, і в яких компаніях. Щоб вимкнути підключення, відкрийте його меню Інші дії, натисніть Видалити та підтвердьте. Його наступний виклик буде відхилено. Підключення залишається в переліку з позначкою Видалено, а кнопка Дозволити знову повертає йому доступ. Щоб підключити новий інструмент, див. Підключення Exa до вашого ШІ-асистента.

Ваш застосунок може створювати компанії Exayard через API для клієнтів, які користуються Exayard лише через ваш продукт. Ваша компанія володіє цими компаніями та оплачує роботу ШІ, що виконується в них. Вони не мають власних учасників, а ваші застосунки встановлюються в них автоматично.

Розділ Облікові записи для ваших клієнтів показує їх адміністраторам: для кожної компанії відображаються Назва і дата в полі Створено. Натисніть Відмовитися та підтвердьте, щоб закрити компанію. Усі застосунки в ній втрачають доступ.

Картка Швидкий старт містить готовий промпт для ШІ-редактора, як-от Claude або Cursor. Натисніть Копіювати промпт і вставте його в редактор. Промпт містить базовий URL API, формат автентифікації, області доступу та схему підпису вебхуків, тож ШІ може створити робочу інтеграцію й запитати у вас потрібні подробиці. Цю картку бачать лише адміністратори, бо для неї потрібен ключ API.

Картка Документація містить посилання Відкрити документацію на повну документацію для розробників, а також на Специфікація OpenAPI, яка описує всі маршрути та схеми. Адміністратори також бачать кнопку Підключити до Claude або Cursor, яка відкриває налаштування для підключення ШІ-асистентів до Exayard.

Розділ Журнали показує запити до API, починаючи з найновіших. У кожному рядку відображаються Метод, Шлях, Статус, Час і Затримка. Натисніть Завантажити ще внизу, щоб переглянути старіші запити.

Адміністратори бачать усі запити. Учасники бачать лише запити, які надійшли не через застосунок.

Адміністратори можуть фільтрувати за полем Застосунок, а потім за одним із ключів цього застосунку. Будь-хто може ввести значення в полі Кінцевий користувач, щоб побачити запити лише цього клієнта. Кінцевий користувач це ваш власний ідентифікатор одного з ваших клієнтів. Ваш код надсилає його з кожним запитом у заголовку Exayard-End-User. Ніколи не використовуйте адресу електронної пошти як ідентифікатор.

Виберіть рядок, щоб переглянути всі подробиці, зокрема ID запиту, застосунок і кінцевого користувача, а також Тіло запиту і Тіло відповіді. Використовуйте журнали, щоб переконатися, що виклик спрацював, або щоб з'ясувати, чому інтеграція не працює.

Адміністратори бачать, скільки кожен застосунок витратив цього місяця, у розділі Витрати за застосунками в Налаштування, а потім Використання. Там також наведено ваші власні застосунки. Під кожним застосунком розділ За ключами показує, скільки витратив кожен ключ, а Найбільші кінцеві користувачі показує п'ятьох кінцевих користувачів із найбільшими витратами. Витрати, не пов'язані з жодним із ключів застосунку, відображаються як Інше.

Місячний ліміт ШІ застосунку це максимальна сума, якої може коштувати вашій компанії його робота ШІ за кожен розрахунковий місяць. Щоб установити його, відкрийте меню Інші дії застосунку в розділі Витрати за застосунками та натисніть Встановити місячний ліміт ШІ. Введіть суму у валюті ваших розрахунків і натисніть Зберегти. Щоб зняти ліміт, збережіть порожнє поле.

Коли застосунок досягає свого ліміту, його робота ШІ відхиляється до кінця розрахункового місяця, навіть якщо у вашої компанії ще залишився обсяг використання ШІ. Власні ліміти вашої компанії також діють. Робота ШІ, яку люди запускають самі, ніколи не зараховується до ліміту застосунку.