Platform Veelgestelde vragen en handleiding voor probleemoplossing

Dit document bevat antwoorden op veelgestelde vragen over Adobe Experience Platform en een gids voor probleemoplossing op hoog niveau voor algemene fouten die in een Experience Platform API. Voor het oplossen van problemengidsen op individueel Platform de diensten, zie servicemap voor probleemoplossing hieronder.

Veelgestelde vragen faq

Hieronder volgt een lijst met antwoorden op veelgestelde vragen over Adobe Experience Platform.

Wat is Experience Platform API's? what-are-experience-platform-apis

Experience Platform biedt veelvoudige RESTful APIs aan die HTTP- verzoeken aan toegang gebruiken Platform middelen. Deze dienst APIs elk stelt veelvoudige eindpunten bloot, en staat u toe om verrichtingen aan lijst (GET), raadpleging (GET) uit te voeren, (PUT en/of PATCH), en (DELETE) middelen uit te geven. Voor meer informatie over specifieke eindpunten en verrichtingen beschikbaar voor elke dienst, gelieve te zien API-naslagdocumentatie op Adobe I/O.

Hoe kan ik een API-aanvraag opmaken? how-do-i-format-an-api-request

De aanvraagindelingen variëren afhankelijk van Platform API die wordt gebruikt. De beste manier om te leren hoe te om uw API vraag te structureren is door samen met de voorbeelden te volgen die in de documentatie voor specifiek worden verstrekt Platform service die u gebruikt.

Voor meer informatie over het opmaken van API-aanvragen raadpleegt u de gids Aan de slag met de platform-API lees voorbeeld API vraag sectie.

Wat is mijn organisatie? what-is-my-ims-organization

Een organisatie is een Adobe vertegenwoordiging van een klant. Om het even welke vergunning gegeven oplossingen van de Adobe zijn geïntegreerd met deze klantenorganisatie. Wanneer een organisatie recht heeft op Experience Platform, kan het toegang toewijzen aan ontwikkelaars. De organisatie-id (x-gw-ims-org-id) staat voor de organisatie waarvoor een API-aanroep moet worden uitgevoerd en is daarom vereist als header in alle API-aanvragen. Deze id is te vinden via de Adobe Developer Console: in de Integraties tabblad, navigeert u naar de Overzicht sectie voor een bepaalde integratie om de id onder te zoeken Client Credentials. Voor een geleidelijke analyse van hoe te voor authentiek te verklaren in Platform, zie de verificatiezelfstudie.

Waar kan ik mijn API-sleutel vinden? where-can-i-find-my-api-key

Een API-sleutel is vereist als een header in alle API-aanvragen. Het kan worden gevonden door Adobe Developer Console. Binnen de console, op de Integraties tabblad, navigeert u naar de Overzicht voor een specifieke integratie, vindt u de sleutel onder Client Credentials. Voor een geleidelijke analyse van hoe te voor authentiek te verklaren om Platform, zie de verificatiezelfstudie.

Hoe krijg ik een toegangstoken? how-do-i-get-an-access-token

Toegangstempens zijn vereist in de machtigingheader van alle API-aanroepen. Ze kunnen worden gegenereerd met behulp van een CURL-opdracht, op voorwaarde dat u toegang hebt tot een integratie voor een organisatie. Toegangstokens zijn slechts geldig gedurende 24 uur, waarna een nieuw teken moet worden geproduceerd om verder te gebruiken API. Voor details bij het produceren van toegangstokens, zie verificatiezelfstudie.

Hoe gebruik ik queryparameters? how-do-i-user-query-parameters

Sommige Platform API-eindpunten accepteren queryparameters om specifieke informatie te zoeken en de resultaten in de reactie te filteren. De parameters van de vraag worden toegevoegd aan verzoekwegen met een vraagteken (?), gevolgd door een of meer queryparameters met de indeling paramName=paramValue. Wanneer het combineren van veelvoudige parameters in één enkele vraag, moet u ampersand (&) aan afzonderlijke parameters. Het volgende voorbeeld toont aan hoe een verzoek dat veelvoudige vraagparameters gebruikt in de documentatie wordt vertegenwoordigd.

Voorbeelden van veelgebruikte queryparameters zijn:

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

Voor gedetailleerde informatie over welke vraagparameters voor de specifieke dienst of een eindpunt beschikbaar zijn, te herzien gelieve de dienst-specifieke documentatie.

Hoe kan ik een JSON-veld aangeven dat moet worden bijgewerkt in een PATCH-verzoek? how-do-i-indicate-a-json-field-to-update-in-a-patch-request

Veel PATCH-bewerkingen in Platform APIs-gebruik JSON-aanwijzer tekenreeksen die JSON-eigenschappen aangeven die moeten worden bijgewerkt. Deze worden meestal opgenomen in aanvraagladingen die JSON Patch gebruiken. Zie de Handleiding voor API-basisbeginselen voor gedetailleerde informatie over de vereiste syntaxis voor deze technologieën.

Mag ik Postman gebruiken om vraag te maken aan Platform API's? how-do-i-use-postman-to-make-calls-to-platform-apis

Postman is een nuttig hulpmiddel om vraag aan RESTful APIs te visualiseren. De Aan de slag-handleiding voor platform-API bevat een video en instructies voor het importeren van Postman-verzamelingen. Bovendien wordt een lijst van de inzamelingen van Postman voor elke dienst verstrekt.

Wat zijn de systeemvereisten voor Platform? what-are-the-system-requirements-for-platform

Afhankelijk van of u de UI of API gebruikt, zijn de volgende systeemvereisten van toepassing:

Voor bewerkingen op basis van UI:

Voor API- en ontwikkelaarsinteracties:

Fouten en problemen oplossen errors-and-troubleshooting

Hieronder volgt een lijst met fouten die u kunt tegenkomen bij het gebruik van Experience Platform service. Voor het oplossen van problemengidsen op individueel Platform de diensten, zie servicemap voor probleemoplossing hieronder.

API-statuscodes api-status-codes

De volgende statuscodes kunnen worden gevonden op Experience Platform API. Elk artikel heeft verschillende oorzaken en daarom zijn de toelichtingen in deze paragraaf algemeen van aard. Voor meer informatie over specifieke fouten in individuele gevallen Platform de diensten, gelieve te zien servicemap voor probleemoplossing hieronder.

Koptekstfouten aanvragen request-header-errors

Alle API-aanroepen in Platform specifieke aanvraagheaders vereisen. Om te zien welke kopballen voor de individuele diensten worden vereist, gelieve te zien API-naslagdocumentatie. Als u de waarden voor de vereiste verificatieheaders wilt vinden, raadpleegt u de Verificatiezelfstudie. Als een van deze headers ontbreekt of ongeldig is bij het aanroepen van een API, kunnen de volgende fouten optreden.

OAuth-token ontbreekt oauth-token-is-missing

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

Dit foutbericht wordt weergegeven wanneer een Authorization header ontbreekt in een API-aanvraag. Zorg ervoor dat de machtigingheader is opgenomen met een geldig toegangstoken voordat u het opnieuw probeert.

OAuth-token is niet geldig oauth-token-is-not-valid

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

Dit foutbericht wordt weergegeven wanneer het toegangstoken in het dialoogvenster Authorization header is not valid. Controleer of het token correct is ingevoerd, of een nieuw token genereren in de Adobe I/O Console.

API-sleutel is vereist api-key-is-required

{
    "error_code": "403000",
    "message": "Api Key is required"
}

Dit foutbericht wordt weergegeven wanneer een API-sleutelheader (x-api-key) ontbreekt in een API-aanvraag. Zorg ervoor dat de header is opgenomen met een geldige API-sleutel voordat u het opnieuw probeert.

API-sleutel is ongeldig api-key-is-invalid

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

Dit foutbericht wordt weergegeven wanneer de waarde van de opgegeven API-sleutelheader (x-api-key) is ongeldig. Controleer of u de sleutel correct hebt ingevoerd voordat u het opnieuw probeert. Als u de API-sleutel niet kent, kunt u deze vinden in het dialoogvenster Adobe I/O-console: in de Integraties tabblad, navigeert u naar de Overzicht sectie voor een specifieke integratie om de API-sleutel onder te zoeken Client Credentials.

Ontbrekende koptekst missing-header

{
    "error_code": "400003",
    "message": "Missing header"
}

Dit foutbericht wordt weergegeven wanneer een organisatiekoptekst (x-gw-ims-org-id) ontbreekt in een API-aanvraag. Zorg ervoor dat de koptekst is opgenomen in de id van uw organisatie voordat u het opnieuw probeert.

Profiel is niet geldig profile-is-not-valid

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

Dit foutbericht wordt weergegeven wanneer de gebruiker of de Adobe I/O-integratie (geïdentificeerd door de toegangstoken in de Authorization header) heeft geen recht om te bellen naar Experience Platform API's voor de organisatie die worden geleverd in de x-gw-ims-org-id header. Zorg ervoor dat u de juiste id voor uw organisatie hebt opgegeven in de koptekst voordat u het opnieuw probeert. Als u uw organisatie-id niet kent, kunt u deze vinden in de Adobe I/O-console: in de Integraties tabblad, navigeert u naar de Overzicht sectie voor een specifieke integratie om de id onder te zoeken Client Credentials.

Fout bij vernieuwen van tag refresh-etag-error

{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}

U kunt een etiketfout ontvangen als een verandering op om het even welke bron of bestemmingsentiteit zoals stroom, verbinding, bronschakelaar, of doelverbinding door een andere API bezoeker werd aangebracht. Vanwege de niet-overeenkomende versie wordt de wijziging die u wilt aanbrengen, niet toegepast op de laatste versie van de entiteit.

Als u dit wilt verhelpen, moet u de entiteit opnieuw ophalen, ervoor zorgen dat de wijzigingen compatibel zijn met de nieuwe versie van de entiteit en vervolgens de nieuwe tag in het dialoogvenster If-Match en tot slot de API-aanroep.

Geldig inhoudstype niet opgegeven valid-content-type-not-specified

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

Dit foutbericht wordt weergegeven wanneer een POST-, PUT- of PATCH-aanvraag ongeldig is of ontbreekt Content-Type header. Zorg ervoor dat de koptekst is opgenomen in de aanvraag en dat de waarde ervan application/json.

Gebruikersgebied ontbreekt user-region-is-missing

{
    "error_code": "403027",
    "message": "User region is missing"
}

Dit foutbericht wordt weergegeven in een van de twee onderstaande gevallen:

Servicemap voor problemen service-troubleshooting-directory

Hieronder volgt een lijst met probleemoplossingsgidsen en API-naslagdocumentatie voor Experience Platform API's. Elke het oplossen van problemengids verstrekt antwoorden op vaak gestelde vragen en oplossingen aan problemen die specifiek zijn voor individueel Platform diensten. De API verwijzingsdocumenten verstrekken een uitvoerige gids aan alle beschikbare eindpunten voor elke dienst, en tonen de instanties van de steekproefaanvraag, reacties, en foutencodes die u kunt ontvangen.