В разделе Для разработчиков вы подключаете Exayard к собственному коду и к приложениям, созданным другими компаниями. Откройте Настройки, затем Для разработчиков. Этот пункт меню настроек видят только администраторы компании. Участник, открывший страницу, может просматривать ее, но не может ничего изменить.

Приложения, API-ключи, вебхуки и журналы доступны на любом тарифе, включая бесплатный. Оплачивается только работа ИИ.

Приложение это одна из ваших интеграций, например «Acme estimator» или «Ночная синхронизация». Каждый 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.

Те же ключи подключают no-code инструменты. См. статьи Подключение 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 клиента и сколько компаний могут его установить.

Администраторы открывают меню Действия по установке, где находятся:

Новое приложение можно установить не более чем в 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 запроса, приложение и конечного пользователя, а также Тело запроса и Тело ответа. Используйте журналы, чтобы убедиться, что вызов прошел успешно, или чтобы выяснить, почему интеграция не работает.

Администраторы видят, сколько потратило каждое приложение в этом месяце, в разделе Расходы по приложениям в Настройки, затем Использование. Ваши собственные приложения тоже перечислены там. Под каждым приложением блок По ключам показывает расходы каждого ключа, а Крупнейшие конечные пользователи показывает пять конечных пользователей с наибольшими расходами. Расходы, не связанные ни с одним из ключей приложения, отображаются как Другое.

Месячный лимит ИИ приложения это максимальная сумма, которую работа ИИ приложения может стоить вашей компании за расчетный месяц. Чтобы задать его, откройте меню Другие действия приложения в разделе Расходы по приложениям и нажмите Задать месячный лимит ИИ. Введите сумму в валюте вашего счета и нажмите Сохранить. Сохраните пустое поле, чтобы снять лимит.

Когда приложение достигает лимита, его работа ИИ отклоняется до конца расчетного месяца, даже если у вашей компании еще остался объем ИИ. Собственные лимиты вашей компании продолжают действовать. Работа ИИ, которую запускают сами пользователи, никогда не учитывается в лимите приложения.