Se connecter à une source de données externe

Si votre base de données hébergée a besoin de se connecter à une source de données externe, son nom est indiqué dans l'URL. Le nom et le mot de passe du compte de la base de données hébergée sont précisés dans la chaîne d'en-tête Authorization. Le nom de la base de données, le nom du compte et le mot de passe de la source de données externes sont quant à eux mentionnés dans le paramètre fmDataSource sous la forme d'un tableau JSON.

Pour une base de données hébergée sur la plateforme Claris, utilisez le nom et le mot de passe du compte Claris étendu que vous avez définis dans Claris Studio. Consultez la section « Créer un compte Claris étendu pour les services Claris Server » du Centre d'aide Claris Studio.

Méthode HTTP

POST

URL

/fmi/data/version/databases/nom-base/sessions

version : la version FileMaker Data API demandée peut utiliser v1, v2 ou vLatest

nom-base est le nom de la base de données hébergée

En-tête HTTP

Content-Type: application/json

Authorization : chaîne codée en base64 représentant le nom et le mot de passe du compte que vous devez utiliser pour vous connecter à la base de données hébergée. Cette chaîne en base64 doit suivre le schéma d'authentification HTTP standard de base.

Pour une base de données hébergée sur la plateforme Claris, utilisez le nom et le mot de passe du compte Claris étendu que vous avez définis dans Claris Studio.
Paramètres

Paramètre fmDataSource avec tableau JSON indiquant le nom de la base de données, le nom du compte et le mot de passe à utiliser pour vous connecter à la source de données externe.

Par exemple :

Copier 
{ "fmDataSource":
  [ { "database":"contacts", "username":"admin", "password":"admin" } ]
}

FileMaker Server uniquement : si vous utilisez un compte OAuth pour vous connecter à la source de données externe, spécifiez la valeur d'en-tête X-FMS-Request-ID (oAuthRequestId) et la valeur de requête d'URL (oAuthIdentifier).

Copier 
{ "fmDataSource":
  [ { "database":"contacts", "oAuthRequestId": "E65B98BB17429CO643B31119F", "oAuthIdentifier": "B164A3459A776E5177445DR223"} ]
}
Réponse

Le jeton d'accès, un corps de réponse vide et un tableau de messages indiquant un code d'erreur de 0.

L'en-tête X-FM-Data-Access-Token est renvoyé dans la réponse. Il correspond au jeton de session à utiliser pour les appels d'API suivants.

Par exemple :

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

Consultez la section Codes d'erreur.

Remarques 

  • Les bases de données Claris et FileMaker sont les seules sources de données externes prises en charge. Indiquez le nom de la base de données sans l'extension :

    • Pour une base de données FileMaker, supprimez .fmp12.

    • Pour une base de données Claris, supprimez .claris.

  • Les fichiers répertoriés dans le paramètre fmDataSource seront ouverts si nécessaire, par exemple, lorsqu'un script est exécuté ou que le contexte est modifié pour un modèle qui nécessite une source de données externe. Par conséquent, les erreurs avec connexion à la source de données externe se produisent lors de la tentative d'ouverture des fichiers, et non lors de la connexion à la session de base de données.