mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-03-27 13:28:32 +07:00
139 lines
11 KiB
Plaintext
139 lines
11 KiB
Plaintext
---
|
||
title: 'APIアクセス'
|
||
summary: '本文書内の「試してみる」機能を使ってDify APIをインタラクティブにテストする方法、ベースURLやAPIキーに関する重要な情報、そしてドキュメントエコシステムへの貢献方法について学びます。'
|
||
---
|
||
|
||
Dify APIドキュメントセンターへようこそ！このガイドは、Dify APIを効果的にテストし理解するために本文書が提供するインタラクティブ機能を活用する方法、そしてAPIアクセスの主要な要素を習得するためのお手伝いを目的としています。
|
||
|
||
**重要事項：**
|
||
|
||
* **このページの内容：** 主にAPIドキュメントのインタラクティブな利用方法、グローバルなアクセス設定（ベースURL、APIキーなど）、およびドキュメントへの貢献プロセスについて説明します。
|
||
* **APIエンドポイント詳細：** 全ての具体的なAPIエンドポイント（パラメータ、リクエスト/レスポンス構造、機能説明、例を含む）の内容は、OpenAPI仕様に基づいて自動生成され、最新の機能に関する注釈が含まれています。**最も正確で詳細なエンドポイント情報については、これらの自動生成されたページを必ず参照してください。**
|
||
|
||
<Card title="APIアクセス" icon="code" href="/api-reference/チャットメッセージ/チャットメッセージを送信" horizontal>
|
||
または上部のナビゲーションバーの「APIアクセス」タブをクリックすると、完全なAPIドキュメントを表示できます。
|
||
</Card>
|
||
|
||
---
|
||
|
||
## インタラクティブなAPIテスト
|
||
|
||
APIを迅速に検証し理解していただくために、本文書のほとんどのAPIエンドポイントページには、「試してみる」(Try It) というインタラクティブなテスト機能が組み込まれています。
|
||
|
||
<Steps>
|
||
<Step title="「試してみる」機能を見つける">
|
||
テストしたいAPIエンドポイントのドキュメントページで、通常はページ上部または右側の領域に、目立つ「試してみる」ボタンまたは直接操作可能なパラメータ入力領域があります。
|
||
</Step>
|
||
<Step title="リクエストパラメータを設定する">
|
||
<AccordionGroup>
|
||
<Accordion title="サーバーアドレス (ベースURL)">
|
||
システムが自動入力試みる場合がありますが、Difyのデプロイ環境（クラウド版またはセルフホスト/オンプレミス版）に応じて正しいベースURLを選択または入力してください。詳細は下記の [サーバーアドレス (ベースURL)](#サーバーアドレス-base-url) セクションを参照してください。
|
||
</Accordion>
|
||
<Accordion title="認証情報 (APIキー)">
|
||
認証セクションに、Difyアプリケーションから取得した有効なAPIキーを入力する必要があります。詳細は [APIキー (API Key)](#apiキー-api-key) セクションを参照してください。
|
||
</Accordion>
|
||
<Accordion title="パスパラメータとクエリパラメータ">
|
||
APIエンドポイントのURLにパスパラメータ (例: `/users/{user_id}`) が含まれる場合や、クエリパラメータ (例: `?limit=10`) が必要な場合は、エンドポイントの説明に従って正確に入力してください。
|
||
</Accordion>
|
||
<Accordion title="リクエストボディ (Request Body)">
|
||
`POST`, `PUT`, `PATCH` など、リクエストボディが必要なHTTPメソッドについては、エンドポイントドキュメントに記載されているリクエストボディの構造 (スキーマ) と例を参照して、正しいJSONコンテンツを作成してください。
|
||
</Accordion>
|
||
</AccordionGroup>
|
||
</Step>
|
||
<Step title="リクエストを送信して結果を確認する">
|
||
すべてのパラメータ設定が完了したら、「送信」(Send) (または「実行」(Execute)) ボタンをクリックしてAPI呼び出しを開始します。しばらくすると、同じ領域にHTTPステータスコード、レスポンスヘッダー、レスポンスボディを含む完全なAPIレスポンスが表示されます。
|
||
</Step>
|
||
</Steps>
|
||
|
||
---
|
||
|
||
## 🔑 APIアクセス設定
|
||
|
||
### サーバーアドレス (ベースURL)
|
||
|
||
APIリクエストのベースURLは、Difyのデプロイ環境によって異なります。
|
||
|
||
<CodeGroup>
|
||
```bash Dify クラウド版
|
||
https://api.dify.ai/v1
|
||
```
|
||
|
||
```bash セルフホスト / オンプレミス版
|
||
http://localhost/v1
|
||
```
|
||
</CodeGroup>
|
||
<Info>
|
||
API呼び出しを行う際や「試してみる」機能を使用する際は、設定したベースURLが正しいことを必ず確認してください。
|
||
</Info>
|
||
|
||
### APIキー (API Key)
|
||
|
||
Difyの**各**アプリケーション (App) は、インターフェース呼び出しの認証と認可に使用される、それぞれ専用のAPIキーを所有しています。
|
||
|
||
* **取得方法：** Difyアプリケーションの概要、`APIアクセス`、または `モニタリング` ページで `APIキー` をクリックして、APIキーを管理または生成できます。
|
||
|
||
* **使用方法：** APIキーを取得したら、HTTPリクエストの `Authorization` ヘッダーに `Bearer YOUR_API_KEY` の形式で追加してください。
|
||
|
||
* **重要なセキュリティに関する注意：**
|
||
<Warning>
|
||
APIキーはアプリケーションデータへのアクセス資格情報であり、高い権限を持っています。**機密情報として扱い、厳重に保管してください。クライアントサイドのコード（ブラウザ、モバイルアプリのフロントエンドなど）にハードコーディングしたり、直接公開したりすることは絶対に避けてください。** APIキーは安全なサーバーサイド環境に保存し、バックエンドサービスを介してDify APIの呼び出しをプロキシすることを推奨します。
|
||
</Warning>
|
||
|
||
* **アクセス制御：** Difyアプリケーションの **モニタリング (Monitoring) -> バックエンドサービスAPI (Backend Service API)** 設定で、APIのアクセス状態を管理できます。例えば、すべてのAPI呼び出しを一時的に無効にすることができます。
|
||
|
||
---
|
||
|
||
## 📚 `APIアクセス`と本文書について
|
||
|
||
### ドキュメントの構成とソース
|
||
|
||
* **本ガイドページ (`api-access-readme.mdx`)：** APIドキュメントの使用方法、インタラクティブテストの実施方法、APIアクセスの一般的な設定情報を提供します。
|
||
* **APIエンドポイント詳細ページ：** サイドバーの **「APIエンドポイント」** グループ以下のすべてのページは、当社のOpenAPI仕様 ([OpenAPI仕様ソースファイルテンプレートを見る](https://github.com/langgenius/dify/tree/main/web/app/components/develop/template)) から **自動生成** されています。これらのページには、各エンドポイントの詳細な説明、パラメータ、リクエスト/レスポンスの例、最新の機能に関する注釈が含まれています。
|
||
|
||
### 本文書への貢献方法
|
||
|
||
Difyドキュメントへのコミュニティメンバーからの貢献を心より歓迎し、感謝いたします！
|
||
|
||
<Tabs>
|
||
<Tab title="現在のページ（本ガイド）を編集する">
|
||
もし **現在ご覧になっているこの `APIアクセスとインタラクションガイド` ページ** を修正したい場合は、以下の手順で行うことができます：
|
||
1. このページの下部までスクロールします。
|
||
2. <Icon icon="pen-to-square" /> **「このページを編集」(Edit this page)** ボタンをクリックします。
|
||
3. これにより、GitHub上のこの `api-access-readme.mdx` ファイルの編集インターフェースに直接移動します。
|
||
|
||
<Note>
|
||
注意：このページ下部の **「このページを編集」** ボタンは、**現在のこのガイドページ (`api-access-readme.mdx`) 自体にのみ作用します**。
|
||
個々の `APIアクセス` 詳細ページには **適用されません**。
|
||
</Note>
|
||
</Tab>
|
||
|
||
<Tab title="APIエンドポイント記述の変更（OpenAPI仕様）">
|
||
`APIアクセス` 詳細ページ内の特定の **APIエンドポイントの説明、パラメータ、または例の更新が必要** な場合、これらの内容はOpenAPI仕様ファイルから来ています。
|
||
1. Difyのドキュメントコードリポジトリにアクセスしてください。
|
||
2. 関連するOpenAPI JSONファイルを見つけます（言語ごとにサブディレクトリに分かれています。例：`en/openapi_chatflow.json`, `zh-hans/openapi_workflow.json` など）。
|
||
3. 対応するOpenAPIファイルの内容を修正します。
|
||
4. Difyのメインリポジトリにプルリクエストを送信します。
|
||
|
||
<Tip>
|
||
多言語ドキュメントの一貫性を保つため、ある言語のOpenAPIファイルを変更した場合は、他の言語バージョンの対応するOpenAPIファイルも確認し、同期して更新することをお勧めします。
|
||
</Tip>
|
||
</Tab>
|
||
|
||
<Tab title="問題の報告または提案">
|
||
ドキュメント（本ガイドページまたは特定のAPIエンドポイントページ）に問題を発見した場合、または改善提案がある場合：
|
||
1. ページ下部（またはサイドバー）の **「問題を報告」(Report an issue)** リンクを使用できます。
|
||
2. これにより、通常、このドキュメントプロジェクト (dify-docs-mintlify) のGitHub Issuesページに移動します。
|
||
3. 発見した問題、問題のあるページのリンク、および改善提案を詳細に記述してください。
|
||
|
||
<Check>
|
||
正確な問題報告と建設的な提案も、コミュニティとプロジェクトへの重要な貢献です！
|
||
</Check>
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
<Card title="同期" icon="rotate" href="https://github.com/langgenius/dify/tree/main/web/app/components/develop/template" horizontal>
|
||
APIドキュメントはDifyのメインリポジトリから同期されています。このカードをクリックすると、GitHubで元のコードを確認できます。同期のずれや誤りを見つけた場合は、ぜひPRを送信してコードに貢献してください。
|
||
</Card>
|
||
|
||
すべての貢献（直接編集または問題報告）にはGitHubアカウントが必要です。より完全なDify利用ドキュメントを共に作り上げるための皆様のご参加をお待ちしております！
|