Salesforce DevOps Woordenlijst

Metadata API

Salesforce's API voor het ophalen en deployen van orgconfiguratie, de basis waarop bijna elke DevOps-tool is gebouwd.

Definitie

De Metadata API is Salesforce's SOAP-gebaseerde API voor het ophalen, deployen, aanmaken en verwijderen van de configuratie (metadata) die een org definieert, zoals custom objects, velden, flows, Apex-klassen en layouts, in tegenstelling tot de records (data) die die objecten bevatten. Het is de basis waarop bijna elke Salesforce DevOps-tool is gebouwd: Salesforce CLI, change sets, en release-tools van derden roepen uiteindelijk allemaal Metadata API-bewerkingen aan om configuratie tussen orgs te verplaatsen.

Deployments via de Metadata API kunnen worden gevalideerd (check-only) voordat ze echt worden uitgevoerd, en ondersteunen destructieve wijzigingen via een apart manifest dat gescheiden blijft van wat wordt gedeployed. Omdat het XML-manifest-gestuurd is, vereisen deployments een accurate package.xml waarin elk opgenomen componenttype en -naam wordt vermeld.

Een slecht of onvolledig manifest is een van de meest voorkomende oorzaken van mislukte Salesforce-deployments, omdat alles wat niet op de lijst staat gewoon wordt overgeslagen in plaats van gemarkeerd. Onze Salesforce DevOps-gids behandelt hoe Metadata API-deployments passen in een volledige releasepipeline.

In de praktijk

Hoe het werkt in Serpent

Serpent gebruikt standaard Metadata API-aanroepen voor elke deployment, met een voetafdruk van nul die in je org wordt geïnstalleerd, en bouwt het packagemanifest automatisch op basis van de componenten die een taak daadwerkelijk raakte, zodat er geen handmatig onderhouden package.xml is om synchroon te houden. Orgvergelijkings- en synchronisatiefuncties lezen de metadatastatus over sandboxes en productie om drift te signaleren voordat een deployment draait, waarbij mismatches worden opgevangen die de Metadata API alleen niet zou signaleren. Zie orgbeheer in Serpent voor hoe metadatavergelijking werkt over je omgevingen.

Git-integratie-instellingen in Serpent
Veelgestelde vragen

Metadata API, beantwoord

Wat is het verschil tussen de Metadata API en de standaard Salesforce API?
De standaard REST- of SOAP-API leest en schrijft records, de data binnen je objecten. De Metadata API leest en schrijft de configuratie die die objecten definieert, zoals velden, flows en Apex-klassen.
Kan ik een Metadata API-deployment valideren zonder deze daadwerkelijk uit te voeren?
Ja, check-only deployments voeren dezelfde validatie uit, inclusief Apex-tests, zonder wijzigingen door te voeren in de doelorg. Het is de standaardmanier om fouten op te sporen vóór een echte deployment.
Waarom is mijn Metadata API-deployment geslaagd maar ontbreekt er een component?
Bijna altijd een onvolledige package.xml. De Metadata API raakt alleen wat in het manifest staat vermeld, dus een component die niet is vermeld, wordt stilletjes overgeslagen in plaats van als fout gemarkeerd.

Start gratis. Geen creditcard, geen installatie, geen verplichting.

Binnen 15 minuten ingericht. Geen DevOps-medewerker nodig.

Benieuwd naar sneller releasen voordat je instapt? Laten we praten

Vrijblijvend.