К основному содержимому

API для разработчиков и вебхуки

Создавайте ключи API, регистрируйте эндпойнты вебхуков и просматривайте журналы запросов в Центре для разработчиков.

Автор: Sarah Chen

Центр разработчика — это место, где вы подключаете Exayard к собственному коду и инструментам. Откройте его из раздела Настройки, затем Разработчик. Здесь вы создаёте API-ключи, регистрируете конечные точки вебхуков и просматриваете журнал каждого API-запроса в реальном времени. Доступ к этой странице имеют только администраторы организации.

API-ключи

API-ключ аутентифицирует запросы к API Exayard. Ключи принадлежат вашей организации, поэтому нужная учётная запись выбирается автоматически и идентификатор организации передавать не нужно.

Откройте вкладку API keys в карточке Credentials и нажмите кнопку +. Дайте ключу Имя, затем выберите его Области доступа. Выберите All, чтобы предоставить все области доступа, или Specific, чтобы выбрать отдельные разрешения. Области доступа следуют разделению на чтение и запись по каждому ресурсу, например read:projects и write:estimates. Область доступа admin:org предоставляет полный доступ. Выбирайте минимальные области доступа, необходимые вашей интеграции.

Exayard показывает полный ключ один раз, сразу после его создания. Скопируйте его тогда, потому что он больше никогда не показывается. После этого каждый ключ отображается со своим именем, замаскированным фрагментом вроде ak_••••1234 и датой последнего использования.

Используйте значок карандаша, чтобы переименовать ключ или изменить его области доступа. Используйте значок корзины, чтобы Отозвать его. Отзыв необратим, и любая интеграция, использующая этот ключ, немедленно перестаёт работать.

Тот же ключ аутентифицирует интеграции без кода. См. Подключение Exayard к Zapier, Подключение Exayard к Make и Подключение Exayard к n8n. О доступе для агентов и ИИ-редакторов см. Подключение к Claude и другим ИИ-инструментам.

Вебхуки

Вебхук указывает Exayard уведомлять ваш сервер, когда что-то происходит. Откройте вкладку Webhooks и нажмите +, чтобы добавить конечную точку. Введите URL, который должен получать доставки, и необязательное Описание.

Выберите, на какие События подписаться. Выберите All, чтобы получать каждое событие, или Specific, чтобы выбрать из списка:

Событие

Срабатывает, когда

project.created

Создан проект

project.updated

Проект изменён

project.archived

Проект архивирован

assessment.started

Начата оценка обмера

assessment.completed

Оценка завершена

assessment.approved

Оценка утверждена

assessment.cancelled

Оценка отменена

estimate.generated

Сформирована смета

bid.generated

Сформирована заявка

file.processed

Обработка загруженного файла завершена

При создании конечной точки Exayard один раз показывает секрет подписи. Скопируйте его тогда, потому что он больше не показывается.

Защита доставок вебхуков

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

Чтобы проверить доставку, заново вычислите подпись с вашим секретом, убедитесь, что метка времени находится в пределах пяти минут от текущего момента, и сравните дайджесты. Неудавшиеся доставки повторяются с экспоненциальной задержкой в течение примерно трёх дней.

Чтобы отредактировать конечную точку, нажмите значок карандаша. Вы можете изменить URL, описание и события, а также задать её Статус как Active или Paused. Приостановленные конечные точки перестают получать доставки. В том же диалоговом окне есть кнопка Rotate secret. Ротация выдаёт новый секрет, а старый немедленно перестаёт работать, поэтому обновите ваш сервер до того, как выполнить ротацию. Значок корзины удаляет конечную точку и прекращает все доставки к ней.

Быстрый старт

Карточка Quick start содержит готовую подсказку для ИИ-редактора, например Claude или Cursor. Нажмите Copy prompt и вставьте её в ваш редактор. Подсказка включает базовый URL API, формат аутентификации, словарь областей доступа и схему подписи вебхуков, чтобы ИИ мог построить каркас рабочей интеграции и запросить у вас нужные ему детали.

Документация

Карточка Documentation ведёт к полной документации для разработчиков и спецификации OpenAPI, которая описывает каждый маршрут и схему. Connect MCP открывает настройку для подключения ИИ-агентов напрямую к Exayard.

Журналы

Раздел Logs записывает ваши самые недавние API-запросы как через REST API, так и через MCP. Каждая строка показывает метод, путь, статус ответа и задержку. Выберите строку, чтобы увидеть полную информацию о ней, включая идентификатор запроса и тела запроса и ответа. Используйте журналы, чтобы подтвердить, что вызов сработал, или для отладки неисправной интеграции.

Нашли ответ на свой вопрос?