Catalog Service API-handleiding

Catalog Service is het recordsysteem voor de gegevenslocatie en -lijn in Adobe Experience Platform. Catalog fungeert als een opslagplaats voor metagegevens of als een "catalogus" waarin u informatie over uw gegevens kunt vinden in Experience Platform , zonder dat u toegang hoeft te krijgen tot de gegevens zelf. Zie het Catalog overzichtvoor meer informatie.

Deze handleiding voor ontwikkelaars bevat stappen waarmee u de API van Catalog kunt gaan gebruiken. De handleiding bevat vervolgens voorbeeld-API-aanroepen voor het uitvoeren van toetsbewerkingen met Catalog .

Vereisten

Catalog houdt metagegevens bij voor verschillende soorten bronnen en bewerkingen binnen Experience Platform . Deze ontwikkelaarshandleiding vereist een goed begrip van de verschillende Experience Platform -services die betrokken zijn bij het maken en beheren van deze bronnen:

De volgende secties bevatten aanvullende informatie die u moet weten of die u zelf moet hebben om aanroepen naar de Catalog Service API te kunnen uitvoeren.

API-voorbeeldaanroepen lezen

Deze gids verstrekt voorbeeld API vraag om aan te tonen hoe te om uw verzoeken te formatteren. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de overeenkomsten die in documentatie voor steekproef API vraag worden gebruikt, zie de sectie op hoe te om voorbeeld API vraagin de Experience Platform het oplossen van problemengids te lezen.

Waarden verzamelen voor vereiste koppen

Om vraag aan Platform APIs te maken, moet u het authentificatieleerprogrammaeerst voltooien. Als u de zelfstudie over verificatie voltooit, krijgt u de waarden voor elk van de vereiste headers in alle API-aanroepen van Experience Platform , zoals hieronder wordt getoond:

Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Alle aanvragen naar Platform API's vereisen een header die de naam van de sandbox opgeeft waarin de bewerking plaatsvindt:

Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra kopbal:

Aanbevolen procedures voor API-aanroepen van Catalog

Wanneer u GET-aanvragen naar de Catalog API uitvoert, kunt u het beste queryparameters opnemen in uw aanvragen om alleen de objecten en eigenschappen te retourneren die u nodig hebt. Door ongefilterde verzoeken kunnen antwoordladingen groter zijn dan 3 GB, wat de algehele prestaties kan vertragen.

U kunt specifieke objecten weergeven door hun id op te nemen in het aanvraagpad of met queryparameters zoals properties en limit om reacties te filteren. Filters kunnen als kopballen en als vraagparameters worden overgegaan, met die overgegaan als vraagparameters die belangrijkheid nemen. Zie het document over het filtreren gegevens van de Catalogusvoor meer informatie.

Aangezien sommige query's een zware belasting voor de API kunnen betekenen, zijn algemene limieten geïmplementeerd voor Catalog query's voor verdere ondersteuning van best practices.

Volgende stappen

Dit document bevatte de vereiste kennis die nodig was om aanroepen uit te voeren naar de Catalog API. U kunt nu aan de steekproefvraag verdergaan die in deze ontwikkelaarsgids wordt verstrekt en samen met hun instructies volgen.

De meeste voorbeelden in deze handleiding gebruiken het eindpunt /dataSets , maar de principes kunnen worden toegepast op andere eindpunten binnen Catalog (zoals /batches ). Zie de Verwijzing van de Dienst API van de Catalogusvoor een volledige lijst van alle vraag en verrichtingen beschikbaar voor elk eindpunt.

Voor een geleidelijke werkschema dat aantoont hoe Catalog API met gegevensopname geïmpliceerd is, zie het leerprogramma op het creëren van een dataset.