Прежде чем погрузиться в код, очень важно понять основополагающие идеи, которые делают опал. Основные концепции последовательны во всех его SDK.
Инструмент проявляется
Представьте, что вы впервые представляете свой инструмент на платформе Opal. Вам нужен хорошо структурированный документ, который точно объясняет, что он есть, что ему нужно и как его использовать. Этот документ является манифестом инструмента. Это единственный источник истины, который гарантирует, что Опал прекрасно понимает ваш инструмент.
Этот план JSON содержит все важные детали:
Имя и описание: Число читаемого «высота лифта» для вашего инструмента.
Параметры: Подробный список каждого ввода, который ожидает ваш инструмент, включая их имена, типы данных (строка, число, логическое и т. Д.), А независимо от того, необходимы они или необязательны.
Как вызвать: Технические инструкции: конкретная конечная точка HTTP (URL) и метод (get/post) должны вызовать для запуска вашего инструмента.
Требования к аутентификации: Инструкции о том, что, если таковые имеются, нужны учетные данные.
Конечная точка открытия
Это конкретный URL -адрес, который должен разоблачить ваш сервис инструментов, обычно AT /Discovery. Когда вы зарегистрирует свой инструмент Opal, это первое место, где он «стучит в дверь». Его единственная задача-ответить на звонок Опала, вернув, что я только что обсудил. Вот как Opal динамически обнаруживает каждый инструмент, который предлагает ваш сервис, без необходимости вручную настроить каждый из них в пользовательском интерфейсе.
Эта конечная точка является критическим рукопожатием между вашим сервисом и платформой Opal. Если он упадет, возвращает ошибку или обеспечивает уловореченный манифест, разговор останавливается еще до того, как она начнется. SDKS автоматизирует его создание, чтобы вы могли сосредоточиться на логике своего инструмента.
Выполнение инструмента
Это главное событие – процесс, когда Opal называет ваш инструмент для выполнения своей реальной работы. Пользователь или процесс в Opal запускает ваш инструмент. Opal упаковывает все предоставленные параметры в аккуратный HTTP -запрос (пост с корпусом JSON). Этот запрос отправляется в назначенную конечную точку выполнения вашего инструмента. Ваш инструмент обрабатывает запрос, выполняет свою задачу (запрашивая базу данных, вызывает API, запустите расчет и т. Д.), А затем возвращает структурированный ответ (как JSON) обратно в Opal. Это фаза «работы». Понимание ожидаемого формата запроса и разработка четкого ответа является ключом к эффективной реализации основной функциональности вашего инструмента.
Аутентификация
Основной уровень безопасности, который обеспечивает только уполномоченные запросы от Opal, может вызвать ваши инструменты и получить доступ к их возможностям.
Токены носителя: Простой, но мощный метод, когда Опал проходит секретный токен в заголовке авторизации. Первая задача вашего инструмента – проверить этот токен, прежде чем делать что -либо еще.
Оаут потоки: Для инструментов, которые взаимодействуют со сторонними услугами (например, Google или Salesforce), ваш инструмент может использовать OAuth через OPAL для надежного доступа к пользовательским данным.
Opal SDK предоставляют встроенные помощники для упрощения реализации этих критических мер безопасности.
Вы хотите узнать больше?
13 сентября 2025 года
Читайте также
