開発者ポータルへのアクセス ​

開発者ポータルには、APIの検出、テスト、利用に必要なすべてのものが用意されています。

ポータルにログイン ​

ログイン方法は、ワークスペースでWorkato Identityを使用しているかどうかによって異なります:

• マジックリンクでログイン: 管理者がメールで招待し、リンクを使用してポータルにアクセスします。
• Workato Identityでログイン: Workato Identityの認証情報を使用するか、組織のIDプロバイダーを通じてログインします。

マジックリンクでログイン ​

管理者から開発者ポータルに招待されると、ポータルにアクセスするためのリンクが記載されたメールを受信します。

Workato Identityでログイン ​

ポータル招待メールを受信した場合は、Invited userタブに従います。 組織がjust-in-time（JIT）プロビジョニングでSSOを使用しており、招待を受信していない場合は、JIT userタブに従います。

開発者ポータルの操作 ​

ログイン後、割り当てられたAPIコレクションの参照、新しいAPIの検出、エンドポイントのテスト、APIキーの管理を行うことができます。

• APIコレクションを参照: 割り当てられたコレクションを表示し、エンドポイントのドキュメントを確認します。
• 新しいAPIを検出: 利用可能な追加のコレクションを参照し、アクセスをリクエストします。
• エンドポイントをテスト: テストリクエストを送信してエンドポイントの動作を検証します。
• APIキーの管理と作成: リクエストの認証に使用するキーを生成および管理します。

APIコレクションの閲覧 ​

My APIsタブで、割り当てられたAPIコレクションにアクセスできます。 コレクションを選択すると、そのドキュメントが開き、エンドポイントメソッド、説明、スキーマを確認できます。 ドキュメントには、リクエストとレスポンスの例が含まれています。 OpenAPI仕様をダウンロードすることもできます。

APIコレクションを参照

新しいAPIを検出 ​

Discover new APIsタブでは、追加のAPIコレクションにアクセスできます。 コレクションを参照してニーズに合うAPIを見つけ、ポータルから直接アクセスをリクエストします。

新しいAPIへのアクセスをリクエスト ​

新しいAPIへのアクセスをリクエストするには、次の手順を実行します:

リクエストが承認されると、リクエストしたAPIがMy APIsタブに表示され、それらのエンドポイントとドキュメントにアクセスできるようになります。

My APIsに追加されたコレクション

エンドポイントのテスト ​

ポータルでAPIエンドポイントを直接テストして、その機能を検証できます。 APIキーをまだ持っていない場合は、テストする前にAPIキーを作成する必要があります。

エンドポイントをテストするには、次の手順を実行します:

APIキーの管理と作成 ​

Manage API keysページを使用して、APIキーを作成および管理します。 許可およびブロックされたIPアドレスなどのセキュリティパラメーターを定義できます。

APIキーを作成するには、次の手順を実行します:

キーを作成すると、Manage API keysページに表示されます。 このページを使用して、トークンの詳細を表示したり、必要に応じてキーを更新、非アクティブ化、削除したりできます。

AIROで検索する ​

AIROは、Developer portalのスマート検索機能です。 自然言語の質問を行い、エンドポイントの推奨、コードスニペット、ドキュメントへのリンクなど、開発者タスクに関する支援を受けることができます。

AIROの仕組み ​

AIROは自然言語の質問を解釈し、エンドポイントの推奨、コードの生成、関連ドキュメントの提示など、ポータル内の開発者タスクを支援します。 応答の範囲は、ポータルに公開されているAPIコレクションに限定されます。

APIを検索する ​

APIは次の方法で検索できます。

• Search field: Search collectionsフィールドにキーワードを入力し、提案されたAsk AIROプロンプトのいずれかを選択します。 ポータルは単一の応答をインラインで返します。 追加の質問がある場合は、Continue in chatをクリックします。
• AIROチャット: Ask AIROをクリックしてチャットを直接開くか、Search collectionsフィールドをクリックし、ドロップダウンメニューからOpen AIROを選択します。 チャットはマルチターンの会話をサポートしているため、同じセッションでフォローアップの質問を行うことができます。

AIROは通常、次の情報を含む応答を返します:

• 使用するエンドポイントとその使用方法についての自然言語による説明。
• プレースホルダー認証を使用したcURLコード例。
• 推奨されるエンドポイントとその親コレクションにリンクするRelated documentationセクション。

AIROがコード例と関連ドキュメントを返す