外部データソースへのログイン

共有データベースで外部データソースにログインする必要がある場合、共有データベースの名前を URL で指定します。共有データベースのアカウント名とパスワードはヘッダの Authorization 文字列で指定します。外部データソースのデータベース名、アカウント名、およびパスワードは JSON 配列として fmDataSource 引数で指定します。

Claris プラットフォーム上で共有されているデータベースの場合、Claris Studio で設定した拡張 Claris アカウント名およびパスワードを使用します。Claris Studio ヘルプセンターの「Claris Server サービスの拡張 Claris アカウントの作成」を参照してください。

HTTP メソッド

POST

URL

/fmi/data/version/databases/database-name/sessions

version – リクエストされた FileMaker Data API のバージョン。v1v2、または vLatest のいずれかを使用できます。

database-name – 共有データベースの名前

HTTP ヘッダ

Content-Type: application/json

Authorization: 共有データベースにログインするために使用するアカウント名とパスワードを表す Base64 エンコード文字列。この Base64 エンコード文字列は標準の HTTP 基本認証スキーマに従う必要があります。

Claris プラットフォーム上で共有されているデータベースの場合、Claris Studio で設定した拡張 Claris アカウント名およびパスワードを使用します。

引数

外部データソースにログインするために使用するデータベース名、アカウント名、およびパスワードを指定する JSON 配列を持つ fmDataSource 引数。

例:

コピー
{ "fmDataSource":
  [ { "database":"contacts", "username":"admin", "password":"admin" } ]
}

FileMaker Server のみ: OAuth アカウントを使用して外部データソースにログインする場合、X-FMS-Request-ID ヘッダの値 (oAuthRequestId) および URL クエリーの値 (oAuthIdentifier) を指定します。

コピー
{ "fmDataSource":
  [ { "database":"contacts", "oAuthRequestId": "E65B98BB17429CO643B31119F", "oAuthIdentifier": "B164A3459A776E5177445DR223"} ]
}
応答

アクセストークン、空の応答のボディ、およびエラーコード 0 を表示するメッセージ配列。

応答で X-FM-Data-Access-Token ヘッダが返されます。これは、以降の API 呼び出しで使用するセッショントークンです。

例:

コピー
X-FM-Data-Access-Token: c13c0f486780f2187bde6f3859dabd4dcf8ea43be420dfeadf34
{
    "response": {},
    "messages":[{"code":"0","message":"OK"}]
}

エラー応答」を参照してください。

メモ 

  • サポートされている外部データソースは Claris および FileMaker データベースのみです。データベース名は拡張子を付けずに指定してください:

    • FileMaker データベースの場合、.fmp12 をファイル名から取り除きます。

    • Claris データベースの場合、.claris を取り除きます。

  • fmDataSource 引数で指定されたファイルは、外部データソースを必要とするレイアウトに対してスクリプトが実行されたとき、またはコンテキストが変更されたときなどに必要に応じて開かれます。結果として、ファイルを開くことを試行したときに外部データソースへのログインによるエラーが発生しますが、データベースセッションにログインしたときには発生しません。