設定とコードを分ける

API のアドレスと認証情報はソースコードの外で管理してください。サーバーの環境変数を使用し、実際のキーをブラウザ用のコードに含めないでください。このデモ連携はサンプルデータのみを使用します。

接続前に仕様を決める

タスクの項目、取り得る状態、エラー形式を API チームと確認しましょう。共通の仕様は手戻りを減らし、ダッシュボードとサービス間の曖昧な動作を防ぎます。

リクエストの流れを計画

タスク作成と結果取得にタイムアウトを設定します。非同期処理では、一定間隔で確認し、試行回数に上限を設けます。期限を過ぎたら、アプリケーションは明確に待機を終了する必要があります。

エラー対応もプロダクトの一部

無効な認証情報、残高不足、サービス停止には個別の対応が必要です。役立つメッセージを表示し、診断に必要な情報だけを記録してください。認証情報や解決トークンは記録しません。

公開前に検証する

検証環境で認証エラー、使用量制限、予期しないレスポンスをテストしてください。このドキュメントはエンドポイントの構成案です。仕様確定後に実際のサービスを接続します。

次のワークフローを体験。

デモダッシュボードを体験してください。

ダッシュボードを開く