# 外部コレクションのAPIとの統合

## 開始前に

* 現在、テキスト、特殊文字、およびUUIDを含むIDをサポートできません。
* 外部コレクションを設定するには、Professional、Team、またはBusinessのAdaloプランに登録する必要があります。

## はじめに

外部コレクションは、APIを使用してアプリを他のアプリやサービスと接続することができる、強力なAdaloの機能です。

外部コレクションを設定すると、通常のコレクションと同様に使用できます。リストを作成するために使用したり、アクションやフォームを使用して外部コレクション内のデータを作成、更新、削除することができます。

## ベースURLの設定

1. 左側のツールバーで、データベースタブをクリックします。
2. 外部コレクションの下で、「コレクションの追加」をクリックします。
3. ポップアップするモーダルで、"Trips"などの名前を付けて外部コレクションを割り当てます。
4. 宛先APIのベースURLを入力します。たとえば、AirtableテーブルのベースURLは次のようになります：<https://api.airtable.com/v0/appdgaWQINJb2Offg/Trips>

![](https://797861279-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EFNSNZLMs5AZ70x2P33%2Fuploads%2Fgit-blob-490e8efb2a653ad37aac0869a7dd3efd92394d83%2FAPI%20Example%20-%20Edited%20-%20Edited%20-%20Edited.gif?alt=media)

5. 認証の設定
   1. ほとんどのAPIは、データにアクセスする権限があることを通知する方法が必要です。これは通常、認証パラメータを使用して行われます。認証パラメータには、\_ヘッダーパラメータ\_または\_クエリパラメータ\_の2種類があります。
   2. 認証パラメータを追加するには、アイテムを追加し、ヘッダーまたはクエリパラメータを選択します。
   3. パラメータの名前と値を追加します。
   4. たとえば、Airtableの認証には、"Authorization"という名前のヘッダーパラメータと、Airtable APIキーの値が必要です。これは、`Bearer keyCidTHSJLgcl9Dn`のようになります。

![](https://797861279-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EFNSNZLMs5AZ70x2P33%2Fuploads%2Fgit-blob-43fe6eaa205a9506fe2e0383d858f0e8c3c13b92%2FAPI%20Example%20-%20Edited.gif?alt=media)

## エンドポイントアクションの設定

各外部コレクションには、次の5つのエンドポイントアクションを設定できます：

1. すべてのレコードを取得
2. 1つのレコードを取得
3. レコードを作成
4. レコードを更新
5. レコードを削除

それぞれにはメソッドとURLがあります。

メソッドは、GET、POST、PUT、PATCH、またはDELETEのいずれかです。Adaloは通常、適切なデフォルトを認識しますので、ほとんどの場合、メソッドを設定する必要はありません。最も一般的な例外は、レコードを更新するエンドポイントです。Airbaseなどの一部のAPIでは、デフォルトのPUTメソッドではなくPATCHに設定する必要があります。

URLも、ベースURLに基づいてデフォルトで設定されますが、すべてのAPIが異なるため、デフォルトのURLを変更する必要があるかもしれません。 エンドポイントをカスタマイズできるもう1つの方法があります。それは、すべてのレコードを取得するエンドポイントです。一部のAPIでは、レコードのリストをリクエストすると、すべての結果が一緒に返されます。このグループの名前は、一般的にトップレベルキーまたは結果キーと呼ばれます。もしAPIにこれがあれば、大丈夫です！ "Results Key"の設定にキーの名前を入力するだけです。たとえば、Airtable APIへの接続を設定している場合、Get All RecordsエンドポイントのResults Keyとして "records" を入力する必要があります。

## 接続をテストする

最後に、APIの設定のテストを実行します。エラーがある場合は、接続しようとしているAPIからのエラーメッセージが表示され、設定を調整できます。すべてがうまくいくと、APIからの例のレスポンスが表示され、設定モーダルを閉じることができます。

接続テスト中に、コレクションのプロパティは自動的に検出され、例のレスポンスに基づいて追加されます。

## 構築を開始！

外部コレクションが設定されたので、これまで使っていた標準コレクションと同じように操作できます。リスト、アクション、フォームは、Adaloに保存されているデータとまったく同じ方法で外部コレクションと連携します。

## ヘルプ

外部コレクションについて詳しくは、[The Adalo App Academy](https://appacademy.adalo.com/)の[External Collection](https://appacademy.adalo.com/course/external-collections)コースで学ぶことができます。