Se connecter à une session de base de données avec un fournisseur d'identité OAuth

Pour vous connecter à une base de données hébergée avec un fournisseur d'identité OAuth, utilisez une méthode HTTP POST avec le point de terminaison API sessions en indiquant la base de données. Utilisez les chaînes X-FM-Data-OAuth-Request-Id et X-FM-Data-OAuth-Identifier dans l'en-tête pour authentifier l'accès à la base de données hébergée. Si l'authentification est acceptée, votre code reçoit un jeton d'accès qui définit la connexion à la base de données. Cette connexion est appelée session de base de données.

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 : nom de la base de données hébergée.

En-tête HTTP

Content-Type: application/json

X-FM-Data-OAuth-Request-Id: id-requête

X-FM-Data-OAuth-Identifier: paramètre-identifiant
Paramètres Un ensemble d'accolades vides. Par exemple : { } Vous pouvez éventuellement utiliser le paramètre fmDataSource pour vous connecter à une source de données externe. Consultez la section Se connecter à une source de données externe.
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
En-tête
X-FM-Data-Access-Token: 823c0f48bb80f2187bde6f3859dabd4dcf8ea43be420dfeadf34
Copier
Corps
{
  "response": {},
  "messages": [
    {
      "code": "0",
      "message": "OK"
    }
  ]
}

Consultez la section Codes d'erreur.

Pour obtenir les paramètres OAuth au format JSON :

  1. Obtenez la liste des fournisseurs OAuth pris en charge au moyen d'une méthode HTTP GET avec l'URL suivante :

    https://hôte/fmws/oauthproviderinfo

    où hôte correspond à l'adresse IP ou au nom de domaine de la machine primaire de votre déploiement FileMaker Server. Cette liste est renvoyée au format JSON.

  2. Choisissez un fournisseur OAuth pris en charge.

  3. Obtenez l'identifiant de suivi de votre session. Utilisez une méthode HTTP GET avec l'URL suivante :

    http://hôte/oauth/getoauthurl?trackingID=ID-suivi&provider=fournisseur-OAuth&address=127.0.0.1&X-FMS-OAuth-AuthType=2

    où hôte correspond à l'adresse IP ou au nom de domaine de la machine primaire de votre déploiement FileMaker Server, ID-suivi est l'identifiant de suivi généré par le développeur pour votre session et fournisseur-OAuth est le nom du fournisseur OAuth sélectionné.

    L'en-tête HTTP de cette requête doit inclure les éléments suivants :

    • X-FMS-Application-Type : 9

    • X-FMS-Application-Version : 15

    • X-FMS-Return-URL : http://127.0.0.1/

  4. Lisez l'en-tête de réponse des données X-FMS-Request-ID. Il contient l'identifiant de requête OAuth que vous utiliserez pour la chaîne X-FM-Data-OAuth-Request-ID de l'en-tête.

  5. Lisez l'en-tête de réponse des données X-FMS-Return-URL. Appelez l'URL renvoyée dans ce paramètre pour autoriser l'utilisateur à s'authentifier auprès du fournisseur OAuth.

  6. L'« identifiant » renvoyé par le fournisseur OAuth est le paramètre d'identifiant OAuth que vous utiliserez pour la chaîne X-FM-Data-OAuth-Identifier de l'en-tête.

Consultez la section Modification de l'accès des comptes OAuth dans l'aide de FileMaker Pro.