Glossaire Salesforce DevOps

Metadata API

L'API de Salesforce pour récupérer et déployer la configuration d'une org, la base sur laquelle repose presque tout outil DevOps.

Définition

L'API Metadata est l'API basée sur SOAP de Salesforce pour récupérer, déployer, créer et supprimer la configuration (métadonnées) qui définit une org, des choses comme les objets personnalisés, les champs, les flows, les classes Apex et les layouts, par opposition aux enregistrements (données) que ces objets contiennent. C'est la base sur laquelle repose presque tout outil Salesforce DevOps : Salesforce CLI, les change sets, et les outils de release tiers appellent tous, en fin de compte, des opérations de l'API Metadata pour déplacer la configuration entre les orgs.

Les déploiements via l'API Metadata peuvent être validés (check-only) avant d'être réellement exécutés, et prennent en charge les changements destructeurs via un manifeste dédié maintenu séparément de ce qui est déployé. Étant piloté par un manifeste XML, un déploiement nécessite un package.xml précis listant chaque type et nom de composant inclus.

Un manifeste mauvais ou incomplet est l'une des causes les plus courantes d'échec des déploiements Salesforce, car tout ce qui est absent de la liste est simplement ignoré plutôt que signalé. Notre guide DevOps Salesforce couvre comment les déploiements de l'API Metadata s'intègrent dans un pipeline de release complet.

En pratique

Comment cela fonctionne dans Serpent

Serpent utilise des appels standard à l'API Metadata pour chaque déploiement, sans aucune empreinte installée dans votre org, et construit automatiquement le manifeste de package à partir des composants qu'une tâche a réellement touchés, de sorte qu'il n'y a pas de package.xml maintenu à la main à synchroniser. Les fonctionnalités de comparaison et de synchronisation d'org lisent l'état des métadonnées à travers les sandboxes et la production pour signaler la dérive avant qu'un déploiement ne s'exécute, détectant des incohérences que l'API Metadata seule ne vous signalerait pas. Voir la gestion des orgs dans Serpent pour savoir comment fonctionne la comparaison de métadonnées à travers vos environnements.

Paramètres d'intégration Git dans Serpent
Questions fréquentes

Metadata API, expliqué

Quelle est la différence entre l'API Metadata et l'API standard de Salesforce ?
L'API REST ou SOAP standard lit et écrit des enregistrements, les données à l'intérieur de vos objets. L'API Metadata lit et écrit la configuration qui définit ces objets, comme les champs, les flows et les classes Apex.
Puis-je valider un déploiement de l'API Metadata sans réellement le déployer ?
Oui, les déploiements check-only exécutent exactement la même validation, y compris les tests Apex, sans valider aucun changement dans l'org cible. C'est la méthode standard pour détecter les échecs avant un déploiement réel.
Pourquoi mon déploiement de l'API Metadata a-t-il réussi tout en omettant un composant ?
Presque toujours un package.xml incomplet. L'API Metadata ne touche que ce qui est listé dans le manifeste, donc un composant non listé est silencieusement ignoré plutôt que signalé comme une erreur.

Démarrez gratuitement. Pas de carte bancaire, pas d'installation, aucun engagement.

Configuration en moins de 15 minutes. Aucun recrutement DevOps nécessaire.

Curieux de livrer plus vite avant de vous lancer ? Parlons-en

Sans engagement.