Разрешить другим программам считывать ваши данные

API Studio: публикация каждого экрана по отдельности, выдача ключа, привязка его к адресу, а также та же публикация, что и на сервере MCP для агента ИИ.

Рано или поздно ваши данные понадобятся кому-то за пределами TRANXACT: инструменту отчетности, системе партнера, веб-сайту, которому нужен прайс-лист, или ИИ-агенту, которому задали вопрос о вашем бизнесе. В API Studio, в разделе «Платформа», вы сами определяете, что именно вам разрешено использовать — по одному экрану за раз, по одной колонке за раз.

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

Четыре решения, в порядке очередности

Публикация экрана

1. Откройте Platform → API Studio и выберите экран. В списке отображаются все экраны, доступные в консоли, считанные непосредственно из продукта — поэтому экран, выпущенный в этом релизе, будет в этом списке.
2. Отметьте галочкой столбцы, которые могут быть удалены. Ничего, что не отмечено галочкой, никогда не отправляется: ни в списке, ни в отдельной записи, ни в том, что возвращается при записи. Ничего не отмечено галочкой изначально, намеренно.
3. Определитесь с глаголами. Функция «Чтение» включена по умолчанию; «Создать», «Изменить» и «Удалить» — это отдельные решения, поскольку разрешить их системе прочитать вашу базу данных товаров и разрешить их системе удалить её — это не одно и то же предложение.
4. При желании можно ограничить количество строк — только проведенные счета-фактуры, только за этот год. Это тот же фильтр, который отображается на каждом экране списка, применяется на сервере при каждом вызове, и ничто, отправленное вызывающей стороной, не может его расширить.
5. Сохраните это. Это черновик, а из черновика ничего не получится. Воплотите его в жизнь, когда это действительно необходимо.
6. Перед тем как передать кому-либо ключ, нажмите кнопку «Предварительный просмотр». Она точно покажет, что получит партнер и сколько столбцов было скрыто.

Регистрация программного обеспечения

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

Сам ключ отображается один раз, при его выдаче, и больше никогда. Выдача нового ключа немедленно прекращает работу старого. Ключ можно отозвать, не удаляя клиента, поэтому в реестре по-прежнему будет указано, кто имел доступ и когда он был отозван.

Где можно использовать ключ

Ключ без разрешенных адресов никуда не ведет. Отсутствие указанных адресов воспринимается как недоступность и никогда не будет восприниматься как доступность из любого места, поскольку утечка ключа, работающего с любого ноутбука в мире, представляет собой весь риск. Существует четыре типа входа: источник из браузера, хост-источник, отдельный адрес или сеть в формате CIDR.

Что отправить тому, кто занимается интеграцией?

Студия выводит четыре адреса. Базовый адрес — /api/v1, ключ помещается в заголовок Authorization: Bearer, в файле /api/v1/resources указан список ресурсов, к которым может обращаться этот ключ, а файл /api/v1/openapi.json идентичен документу OpenAPI 3.1.

Оба эти документа генерируются на основе ключа, который их запрашивает. Партнеру никогда не передают документ со списком из сорока конечных точек, к которым он не может обратиться: в его документе точно указано, к чему он может обратиться, и ничего больше, и в нем не может быть описан путь, который будет отклонен, поскольку он построен на основе тех же строк, которые проверяет обработчик запросов.

Те же данные для агента ИИ.

Адрес /api/v1/mcp — это сервер протокола контекста модели (Model Context Protocol). Агенту, подключающемуся к нему, предлагается инструмент для каждой операции, которую может выполнить ключ, и ничего больше — нет инструмента для данных, которые никто не опубликовал, нет инструмента для глагола, который никто не предоставил. Это одна и та же публикация, описанная для модели, а не для разработчика, поэтому эти два понятия никогда не могут расходиться.

Что происходит во время каждого звонка?

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

Каждый вызов записывается, разрешен или отклонен, с указанием причины. Этот журнал находится в разделе Платформа → API Studio → Журнал вызовов API, и наиболее интересной строкой в нем является ключ, предоставленный с адреса, который никому не был разрешен.

Когда это не работает