Catalog Service API-handleiding
Catalog Service is het registratiesysteem voor 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 binnen Experience Platform, zonder toegang tot de gegevens zelf. Zie de Catalog overzicht voor meer informatie .
Deze handleiding voor ontwikkelaars bevat stappen waarmee u de functie Catalog API. De gids verstrekt dan steekproefAPI vraag om zeer belangrijke verrichtingen uit te voeren gebruikend Catalog.
Vereisten
Catalog controleert meta-gegevens voor verscheidene soorten middelen en verrichtingen binnen Experience Platform. Deze ontwikkelaarshandleiding vereist een goed begrip van de verschillende Experience Platform diensten die betrokken zijn bij het creëren en beheren van deze middelen:
- Experience Data Model (XDM): Het gestandaardiseerde kader waarbinnen Platform organiseert de gegevens van de klantenervaring.
- Inname in batch: Hoe Experience Platform Hiermee worden gegevens uit gegevensbestanden, zoals CSV en Parquet, ingepakt en opgeslagen.
- Streaming opname: Hoe Experience Platform Voert gegevens van client- en server-side apparaten in real-time in en slaat deze op.
De volgende secties verstrekken extra informatie die u zult moeten kennen of hebben aan met succes vraag aan Catalog Service API.
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 conventies die worden gebruikt in documentatie voor voorbeeld-API-aanroepen raadpleegt u de sectie over voorbeeld-API-aanroepen lezen in de Experience Platform gids voor probleemoplossing.
Waarden verzamelen voor vereiste koppen
Om vraag te maken aan Platform API's, moet u eerst de verificatiezelfstudie. Het voltooien van de zelfstudie over verificatie biedt de waarden voor elk van de vereiste kopteksten in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:
- Toestemming: houder
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Alle verzoeken aan Platform API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:
- x-sandbox-name:
{SANDBOX_NAME}
Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra kopbal:
- Inhoudstype: application/json
Aanbevolen procedures voor Catalog API-aanroepen
Bij het uitvoeren van GET-aanvragen bij de Catalog API, de beste praktijken moeten vraagparameters in uw verzoeken omvatten om slechts de voorwerpen en de eigenschappen terug te keren die u nodig hebt. Door ongefilterde verzoeken kunnen antwoordladingen groter zijn dan 3 GB, wat de algehele prestaties kan vertragen.
U kunt specifieke objecten bekijken door hun id op te nemen in het aanvraagpad of met queryparameters zoals properties en limit op filterreacties. Filters kunnen als kopballen en als vraagparameters worden overgegaan, met die overgegaan als vraagparameters die belangrijkheid nemen. Document weergeven op catalogusgegevens filteren voor meer informatie .
Aangezien sommige query's een zware belasting voor de API kunnen betekenen, zijn globale limieten geïmplementeerd op Catalog vragen om de beste praktijken verder te ondersteunen.
Volgende stappen
Dit document bevatte de vereiste kennis die nodig was om oproepen te doen aan de Catalog API. U kunt nu aan de steekproefvraag verdergaan die in deze ontwikkelaarsgids wordt verstrekt en samen met hun instructies volgen.
In de meeste voorbeelden in deze handleiding wordt de /dataSets , maar de beginselen kunnen worden toegepast op andere eindpunten binnen Catalog (zoals /batches). Zie de Referentie voor de Catalog Service API voor een volledige lijst van alle vraag en verrichtingen beschikbaar voor elk eindpunt.
Voor een stapsgewijze workflow die aantoont hoe de Catalog API is betrokken bij gegevensinvoer, raadpleeg de zelfstudie over een gegevensset maken.