Partager via

Automatiser les déploiements du portail des développeurs

  • Article

S’APPLIQUE À : Développeur | Essentiel | Essentiel v2 | Standard | Standard v2 | Premium

Le portail des développeurs Gestion des API prend en charge l’accès par programme au contenu. Elle vous permet d’importer ou d’exporter des données à partir d’un service Gestion des API via l'API REST de gestion de contenu. L’accès à l’API REST fonctionne pour les portails gérés et auto-hébergés.

Script de migration automatisé

Vous pouvez utiliser l’API pour automatiser la migration de contenu entre deux services Gestion des API (par exemple, un service dans l’environnement de test et un service dans l’environnement de production). Le script scripts.v3/migrate.js dans le référentiel GitHub du portail des développeurs de gestion des API simplifie ce processus d’automatisation.

Avertissement

Le script supprime le contenu du portail des développeurs dans votre service Gestion des API de destination. Si vous en avez besoin, veillez à effectuer une sauvegarde.

Notes

Si vous utilisez un portail autohébergé avec un compte de stockage personnalisé défini explicitement pour héberger des fichiers multimédias (en d’autres termes, si vous définissez le paramètre blobStorageUrl dans le fichier config config.design.json), vous devez utiliser le scripts/migrate.jsscript d’origine. Le script d’origine ne fonctionne pas pour les portails gérés ou auto-hébergés avec le compte de stockage multimédia géré par Gestion des API. Dans ce cas, utilisez plutôt le script à partir du dossier /scripts.v3.

Le script effectue les étapes suivantes :

  1. Capturez le contenu et les médias du portail à partir du service Gestion des API source.
  2. Supprimez le contenu du portail et le support du service Gestion des API de destination.
  3. Chargez le contenu du portail et le support du service Gestion des API de destination.
  4. Éventuellement et pour les portails gérés uniquement - publication automatique du portail.

Une fois l’exécution du script terminée, le service Gestion des API cible doit contenir le même contenu du portail que le service source et vous pouvez le voir en tant qu’administrateur.

  • Si vous utilisez un portail géré, vous pouvez configurer le script pour qu’il publie automatiquement le portail de destination afin que la version migrée soit automatiquement disponible pour les visiteurs.
  • Si vous utilisez un portail auto-hébergé, vous devez publier le portail de destination manuellement. Suivez les instructions de publication et d’hébergement dans le didacticiel pour configurer un portail de développement auto-hébergé.

Étapes suivantes

Pour plus d’informations sur le portail des développeurs :