Sécuriser l'API

Gestion des consommateur·trices

L'API générée depuis votre jeu de données est accessible uniquement via l'authentification basique ou l'authentification par clé API. Sélectionnez la méthode d'authentification dans le formulaire de configuration de l'API lors de l'ajout des consommateurs autorisés.

• Pour l'authentification basique, définissez un identifiant et un mot de passe pour votre consommateur·trice.

  Pour appeler l'API, vous devez ajouter un en-tête d'autorisation (Authorization). La valeur doit être Basic, suivie de la chaîne de caractères username (identifiant):password (mot de passe) encodée en Base64. Par exemple : Basic dXNlcm5hbWU6cGFzc3dvcmQ=.

• Pour l'authentification par clé API, utilisez la clé générée dans l'en-tête de votre requête.

  Pour appeler l'API, vous devez ajouter un en-tête d'autorisation (Authorization). La valeur doit être Token (Jeton), suivi par la clé API générée au cours de la configuration de l'API. Par exemple : Token apic.data-api_3KF0MT_EalJeneqZZC3BVTm9J3ft6s66vAb3g_EgI0K7.

Utiliser HTTPS

Si vous utilisez un jeu de données avec une connexion Moteur distant Gen2, vous pouvez configurer le protocole HTTPS pour votre API. Vous pouvez le faire en mettant à jour la configuration NGINX dans le dossier default/nginx, dans le répertoire Moteur distant Gen2.

Pour vous permettre de paramétrer une configuration HTTPS simple, le fichier default/nginx/nginx.conf comprend un exemple commenté de configuration.

1. Commentez la ligne suivante :

    listen              9102; # Do not change this port number

2. Décommentez les lignes suivantes :

   # listen              9103 ssl;  # Do not change this port number
       # ssl_certificate     cn.crt;    # The name of your public certificate file. Put it next to this nginx.conf
       # ssl_certificate_key cn.key;    # The name of your private key file. Put it next to this nginx.conf

   Les fichiers .crt et .key doivent être situés dans le dossier default/nginx.

3. Assurez-vous que les noms référencés dans default/nginx/nginx.conf pour les fichiers .crt et .key correspondent bien à vos noms de fichiers.