Разработчикам

Использование API-ключей и Shortcuts

Подключение повторяющихся рабочих процессов захвата или транскрипции без раскрытия секретов.

Аудитория
Разработчики и опытные пользователи, интегрирующие Vowise в существующие рабочие процессы.
Время
18 минут
Уровень
Продвинутый

Сценарий

Сначала проверьте, для какого рабочего процесса создано это руководство, затем переходите к шагам.

Как создатель автоматизации, я хочу иметь повторяющийся способ отправки аудио в Vowise, чтобы подключать инструменты захвата без ручной загрузки файлов.

Вы знаете, где размещать API-ключи, как тестировать общедоступную ссылку и какие правила обработки секретов соблюдать.

Шаги

1

Создание или поиск API-ключа

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

Ключ хранится вне репозитория.
Скриншоты маскируют или опускают ключ.
2

Тестирование общедоступной API-ссылки

Используйте `/api-reference`, чтобы понять структуру общедоступной транскрипции и запроса словаря перед помещением в автоматизацию.

Вы знаете формат заголовка аутентификации.
Вы знаете, какие конечные точки являются общедоступными.
3

Создание оболочки автоматизации

Оберните запрос в Shortcuts, локальный скрипт или серверный рабочий процесс, который может хранить ключ в секрете.

Рабочий процесс не выводит ключ в журналы.
Сбои видны без раскрытия учетных данных.

Детали

Правила обработки секретов

Документация может обучать структуре запроса, но примеры должны использовать заполнители вместо реальных секретов, повторно используемых паролей или приватных URL-адресов.

  • Используйте заполнители в документации и скриншотах.
  • Храните реальные ключи в локальных хранилищах секретов или серверной конфигурации.
  • Смените ключ, если он появляется в общедоступной записи.

Связанные пути функций

Это руководство не должно быть тупиком. Ниже естественные следующие функции и рабочие процессы.