API Managed Runtime

Utilisez l’API Managed Runtime pour contrôler les applications déployées sur le Managed Runtime de Commerce Cloud. Vous pouvez créer des outils personnalisés avec les mêmes fonctionnalités que l’application web Runtime Admin, mais qui bénéficient d’options d’administration et de configuration supplémentaires.

L'API Managed Runtime est destinée à des fins d'administration uniquement. Ne lancez surtout pas de request à l'API dans le code de votre boutique.

Ce guide suppose que vous connaissez déjà Managed Runtime et ses concepts associés, tels que les projets, les environnements, les paquets et les déploiements. Pour en savoir plus, consultez le document Présentation de Managed Runtime.

La marque Mobify apparaît encore dans le domaine mobify.com dans l'URL de base de l'API Managed Runtime. Même si de nouveaux domaines Salesforce remplaceront à terme le domaine Mobify, la prise en charge de ce dernier sera maintenue.

Pour lancer des requests API, vous devez inclure une clé d'API dans l'en-tête Authorization de la request HTTP avec la valeur Bearer {{api_key}}.

Pour trouver votre clé d'API, connectez-vous à l'outil Runtime Admin et accédez à la page Account Settings.

Considérez votre clé d'API comme un mot de passe, car elle permet aux scripts d'effectuer des opérations en votre nom.

Nous allons vous montrer comment utiliser l'API avec un bref tutoriel et quelques exemples de requests, qui sont formatées comme des commandes curl.

Avant d'exécuter les commandes, indiquez des valeurs réelles dans les espaces réservés. Les espaces réservés sont mis en forme comme ceci : {{placeholder}}.

Pour la plupart des requests, vous devez remplacer {{project_id}} par votre identifiant de projet réel. Pour trouver l'identifiant de votre projet, connectez-vous à l'outil Runtime Admin et accédez à la page des paramètres de votre projet.

Les identifiants de projet peuvent comporter jusqu'à 20 caractères et doivent être uniques pour l'organisation.

Notre première request à l'API Managed Runtime répertorie tous les environnements (ou « targets », soit cibles, comme on les appelle dans l'API) qui appartiennent à un projet :

Créons maintenant un environnement appelé staging que nous pourrons utiliser pour contrôler les changements avant de les déployer vers l'instance production :

Pour utiliser votre nouvel environnement, vous devez y déployer un paquet.

Passons en revue les détails de l'environnement staging que nous avons créé :

Enfin, modifions la configuration du proxy pour staging :

La modification de la configuration entraîne le redéploiement automatique du paquet actuel afin que les changements puissent prendre effet.

Si vous rencontrez des difficultés à utiliser l’API, essayez ces étapes de dépannage :

  • Ajoutez l'argument --fail à votre commande curl.
  • Vérifiez votre clé d'API.
  • Vérifiez l'identifiant de votre projet.

Les points de terminaison de l'API fonctionnent également dans un navigateur. Connectez-vous à l'outil Runtime Admin, puis ouvrez le point de terminaison que vous utilisez directement dans votre navigateur.

Vous connaissez maintenant les possibilités de l'API, et vous avez même lancé quelques requests ! Pour en savoir plus sur l'API, consultez la spécification d'API.