Documentation technique

Configuration

Un client OAuth représente une entité externe qui cherche à utiliser un service Apidae.
Un client est systématiquement rattaché à un projet. A l’heure actuelle seul les projets de type SSO, métadonnées et écriture permettent la création de clients, les projets de diffusion reposent sur une authentification projet/clé d’API.

Création

Pour créer un nouveau client, rendez-vous sur la page de votre projet dans Diffuser > Projets > Mes Projets. Sur les projets SSO ou métadonnées, un bloc en bas de l’onglet Informations Générales permet de créer des nouveaux clients pour votre projet.

Client-oauth

Lors de la création du client vous serons demandées les informations suivantes :

  • Une liste d’adresses e-mail : elle sera utilisée une seule fois à la création du client pour envoyer la clé secrète.
  • Une description : présentée à l’utilisateur lors de l’autorisation d’accès.
  • Une liste d’URI de redirection : la liste des URI autorisées pour la redirection des webservices d’autorisation et d’authentification (voir Single Sign On)

A l’issue de la création, une clé secrète vous sera envoyée par mail. Conserver bien cette clé, qui est essentielle à l’authentification avec votre client.

Authentification

L’authentification repose sur le couple clientId et clé secrète.  Voir Single Sign On (nécessite l’accord d’un utilisateur Apidae) ou Authentification Client Credentials (sans intervention de tiers).

Le clientId est une chaîne de caractères alpha-numériques unique (UUID) qui identifie votre client. Elle est disponible a tout moment dans la liste des clients qui se trouve sur la page de votre projet.

La clé secrète est une chaîne de caractères qui permet l’authentification de votre client via le protocole OAuth. Elle doit rester secrète et ne doit pas être communiquée.