開発者
APIキーとショートカットを使用する
機密情報を公開せずに、繰り返し可能なキャプチャまたは転送ワークフローを接続します。
- 対象
- 既存のワークフローにVowiseを統合する開発者とパワーユーザー。
- 時間
- 18分
- 難易度
- 高度
シナリオ
手順に進む前に、このガイドが想定するワークフローを確認します。
自動化ビルダーとして、ファイルを手動でアップロードすることなく、キャプチャツールを接続するために、繰り返し可能な方法でVowiseにオーディオを送信したい。
APIキーの適切な場所、公開インターフェースのテスト方法、および従うべき秘密処理ルールを知っています。
手順
1
APIキーを作成または検索する
APIキー用に意図されたアカウントインターフェースを使用します。キーを公開チュートリアルコンテンツではなく、秘密として扱います。
キーはリポジトリの外に保存されています。
スクリーンショットはキーをマスクまたは省略します。
2
公開APIリファレンスをテストする
自動化に配置する前に、公開の転送と辞書リクエストの形式を理解するために`/api-reference`を使用します。
認証ヘッダーの形式を知っています。
どのエンドポイントが公開されているかを知っています。
3
自動化ラッパーを構築する
キーをプライベートに保てるショートカット、ローカルスクリプト、またはサーバーサイドワークフローでリクエストをラップします。
ワークフローはログにキーを出力しません。
認証情報を公開せずに失敗が表示されます。
詳細
秘密処理ルール
ドキュメントはリクエストの形式を教えることができますが、例には実際の秘密、再利用可能なパスワード、またはプライベートURLの代わりにプレースホルダーを使用する必要があります。
- ドキュメントとスクリーンショットでプレースホルダーを使用します。
- 実際のキーをローカルの秘密ストアまたはサーバーサイドの設定に保持します。
- キーが公開された録画に表示された場合は、すぐにローテーションします。
関連する機能パス
このチュートリアルで終わらず、自然につながる次の機能とワークフローを確認できます。