Connexion en cours

L'accès à IBM® Cloudant® for IBM Cloud® s'effectue via une API HTTP. La liste suivante contient les différents éléments utilisés pour vous connecter à IBM Cloudant :

  • Noeuds finaux
  • Données d'identification du service
  • Authentification
  • Accès au tableau de bord IBM Cloudant
  • Accès programmatique à IBM Cloudant à l'aide de curl ou de bibliothèques clientes

Noeuds finaux

L'accès à IBM Cloudant s'effectue via les noeuds finaux d'API HTTP. Les nœuds finaux d'une instance sont affichés dans la zone URL des données d'identification de service générées pour l'instance, et dans Compte > Paramètres du Tableau de bord IBM Cloudant.

Tous les noeuds finaux HTTP IBM Cloudant doivent être accessibles via TLS et commencer par https://.

Le noeud final externe accessible au public est illustré dans l'exemple suivant:

https://$ACCOUNT.cloudant.com

Toutes les instances créées après 1er janvier 2019 incluent un noeud final de domaine appdomain.cloud. Le noeud final externe accessible au public est illustré dans l'exemple suivant:

https://$ACCOUNT.cloudantnosqldb.appdomain.cloud

Des noeuds finaux privés (internes) sont ajoutés à toutes les instances déployées sur les environnements du plan Dedicated Hardware. Le noeud final de réseau IBM Cloud Private (interne) est illustré dans l'exemple suivant :

https://$ACCOUNT.private.cloudantnosqldb.appdomain.cloud

Dans l'exemple précédent, « ACCOUNT » est le nom de service de l'utilisateur de l'instance de service dans « URL ». Un exemple d' ACCOUNT e est de810d0e-763f-46a6-ae88-50823dc85581-bluemix, et l'exemplaire de point de terminaison externe qui en résulte serait de810d0e-763f-46a6-ae88-50823dc85581-bluemix.cloudantnosqldb.appdomain.cloud.

Pour plus d'informations sur le blocage de la connectivité des réseaux publics en utilisant la mise sur liste d'adresses IP autorisées, voir Contrôle d'accès sécurisé.

Données d'identification du service

Pour générer des données d'identification de service pour IBM Cloudant à l'aide de IBM Cloud Tableau de bord, voir le tutoriel Création d'une instance IBM Cloudant sous IBM Cloud. Pour générer des données d'identification de service à partir de l'interface de ligne de commande IBM Cloud, voir Création d'une instance avec l'interface de ligne de commande.

L'exemple suivant illustre des données d'identification de service pour une instance IBM Cloudant :

{
  "apikey": "MxVp86XHkU82Wc97tdvDF8qM8B0Xdit2RqR1mGfVXPWz",
  "host": "76838001-b883-444d-90d0-46f89e942a15-bluemix.cloudant.com",
  "iam_apikey_description": "Auto generated apikey during resource-key [...]",
  "iam_apikey_name": "auto-generated-apikey-050d21b5-5f[...]",
  "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
  "iam_serviceid_crn": "crn:v1:staging:public:iam-identity::[...]",
  "password": "8fb6a16b48903e87b769e7f4968521e85c2394ed8f0e69b2769e56dcb27d2e76",
  "port": 443,
  "url": "https://<username>:<password>@76838001-b883-444d-90d0-46f89e942a15-bluemix.cloudant.com",
  "username": "apikey-v2-58B528DF5397465BB6673E1B79482A8C"
}

Les données d'identification de service incluent les zones suivantes :

username
Nom d'utilisateur requis par les applications pour accéder à l'instance de service.
password
Mot de passe d'identification requis par les applications pour accéder à l'instance de service. Cette zone s'affiche uniquement si l'option Use both legacy credentials and IAM a été sélectionnée.
host
Le nom d'hôte utilisé par les applications pour localiser l'instance du service. Cette zone s'affiche uniquement si l'option Use both legacy credentials and IAM a été sélectionnée.
port
Numéro de port HTTPS pour l'accès à l'instance de service sur l'hôte. Il s'agit du numéro 443 car seul l'accès HTTPS est autorisé par IBM Cloudant. Cette zone s'affiche uniquement si l'option Use both legacy credentials and IAM a été sélectionnée.
url
URL HTTPS d'accès à l'instance IBM Cloudant. Si l'option Use both legacy credentials and IAM a été sélectionnée, elle inclut également le nom d'utilisateur et le mot de passe intégrés existants.
apikey
La clé d'API IAM.
iam_apikey_description
Description de la clé d'API IAM.
iam_apikey_name
ID de la clé d'API IAM.
iam_role_crn
Rôle IAM associé à la clé d'API IAM.
iam_serviceid_crn
CRN de l'ID de service.

Authentification

IBM Cloudant comporte deux méthodes d'authentification disponibles lors de la mise à disposition: Use only IAM ou Use both legacy credentials and IAM. Vous ne pouvez voir les détails sur vos données d'identification existantes dans les données d'identification de service que si la méthode d'authentification Use both legacy credentials and IAM est choisie. Les données d'identification s'affichent sur l'onglet Données d'identification pour le service, pour votre instance. Pour plus d'informations, consultez le guide IAM et le document sur l'authentification héritée pour plus de détails sur l'utilisation de l'un ou l'autre de ces modes d'authentification.

L'équipe IBM Cloudant recommande l'utilisation des contrôles d'accès IAM pour l'authentification à chaque fois que c'est possible. Si vous utilisez l'authentification héritée d' IBM Cloudant, vous devez utiliser des clés API plutôt que des identifiants de compte pour l'accès programmatique et les tâches de réplication.

Tableau de bord IBM Cloudant

Vous pouvez ouvrir le tableau de bord IBM Cloudant pour votre instance en accédant à l'onglet Gérer de la page des détails de l'instance du tableau de bord IBM Cloud. Vous pouvez utiliser Launch ou Launch Cloudant Dashboard pour ouvrir le tableau de bord dans un nouvel onglet de navigateur. Vous pouvez effectuer les tâches suivantes à l'aide du tableau de bord IBM Cloudant :

  • Surveiller votre consommation actuelle de l'instance.
  • Exécuter des opérations de création, d'extraction, de mise à jour et de suppression sur les bases de données, les documents et les index IBM Cloudant.
  • Configurer et afficher les travaux de réplication.
  • Afficher les tâches actives.
  • Afficher et mettre à jour des informations de compte, comme la capacité de débit mise à disposition, les annonces, les partages CORS et les paramètres.

Accès par programme

Ligne de commande (curl)

Vous pouvez optimiser l'utilitaire de ligne de commande curl pour accéder à l'API HTTPS IBM Cloudant.

Pour plus d'informations, voir Utilisation de curl. La rubrique Utilisation de curl contient des détails sur la spécification d'un nom d'utilisateur et d'un mot de passe pour accéder à l'API IBM Cloudant avec curl.

Si vous utilisez l'authentification IAM IBM Cloud, vous devez d'abord obtenir un jeton IAM IBM Cloud en utilisant une clé d'API. Vous passez le jeton IAM à l'instance IBM Cloudant pour vous authentifier. Pour plus d'informations, consultez le tutoriel « Transmission d'un jeton IAM d' IBM Cloud pour s'authentifier auprès de l'API d'un service ».

Vous ne pouvez pas utiliser une clé d'API IAM directement pour vous authentifier auprès d'IBM Cloudant.

Bibliothèques client

IBM Cloudant dispose de bibliothèques client officielles et prises en charge pour Java™, Node.js, Python, Swift, Go et les appareils mobiles. Pour plus d'informations, voir laDocumentation des bibliothèques client pour accéder aux bibliothèques et voir des exemples de connexion à un fichier IBM Cloudant Instance pour chaque.