Platform Vanliga frågor och felsökningsguide

Det här dokumentet innehåller svar på vanliga frågor om Adobe Experience Platform samt en felsökningsguide på hög nivå för vanliga fel som kan uppstå i ett Experience Platform-API. Felsökningsguider för enskilda Platform-tjänster finns i tjänstens felsökningskatalog nedan.

Vanliga frågor och svar faq

Nedan följer en lista med svar på vanliga frågor om Adobe Experience Platform.

Vad är Experience Platform API:er? what-are-experience-platform-apis

Experience Platform erbjuder flera RESTful API:er som använder HTTP-begäranden för att komma åt Platform-resurser. Dessa tjänst-API:er visar flera slutpunkter och gör att du kan utföra åtgärder för att lista (GET), söka (GET), redigera (PUT och/eller PATCH) och ta bort (DELETE) resurser. Mer information om specifika slutpunkter och åtgärder som är tillgängliga för respektive tjänst finns i API-referensdokumentationen på Adobe I/O.

Hur formaterar jag en API-begäran? how-do-i-format-an-api-request

Format för begäranden varierar beroende på vilket Platform-API som används. Det bästa sättet att lära sig hur du strukturerar dina API-anrop är att följa med exemplen i dokumentationen för den Platform-tjänst som du använder.

Mer information om hur du formaterar API-begäranden finns i guiden läser exempel-API-anrop för plattforms-API getting started.

Vad är min organisation? what-is-my-ims-organization

En organisation är en Adobe-representation av en kund. Alla licensierade Adobe-lösningar är integrerade med den här kundorganisationen. När en organisation är berättigad till Experience Platform kan den tilldela utvecklare åtkomst. Organisations-ID:t (x-gw-ims-org-id) representerar organisationen som ett API-anrop ska köras för och krävs därför som huvud i alla API-begäranden. Det här ID:t finns på Adobe Developer Console: Gå till Översikt på fliken Integrationer för att hitta ID:t under Klientautentiseringsuppgifter. En stegvis genomgång av hur du autentiserar dig för Platform finns i självstudiekursen för autentisering.

Var hittar jag min API-nyckel? where-can-i-find-my-api-key

En API-nyckel krävs som huvud i alla API-begäranden. Den kan hittas via Adobe Developer Console. Gå till avsnittet Översikt på fliken Integrationer i konsolen för en viss integrering och du hittar nyckeln under Klientautentiseringsuppgifter. En stegvis genomgång av hur du autentiserar till Platform finns i självstudiekursen för autentisering.

Hur får jag en åtkomsttoken? how-do-i-get-an-access-token

Åtkomsttoken krävs i auktoriseringsrubriken för alla API-anrop. De kan genereras med ett CURL-kommando, förutsatt att du har tillgång till en integrering för en organisation. Åtkomsttoken är bara giltiga i 24 timmar. Därefter måste en ny token skapas för att du ska kunna fortsätta använda API:t. Mer information om hur du genererar åtkomsttoken finns i självstudiekursen Autentisering.

Hur använder jag frågeparametrar? how-do-i-user-query-parameters

Vissa Platform API-slutpunkter accepterar frågeparametrar för att hitta specifik information och filtrera resultaten som returneras i svaret. Frågeparametrar har lagts till för att begära sökvägar med ett frågetecken (?), följt av en eller flera frågeparametrar med formatet paramName=paramValue. När du kombinerar flera parametrar i ett enda anrop måste du använda ett et-tecken (&) för att separera enskilda parametrar. I följande exempel visas hur en begäran som använder flera frågeparametrar återges i dokumentationen.

Exempel på vanliga frågeparametrar är:

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

Mer information om vilka frågeparametrar som är tillgängliga för en viss tjänst eller slutpunkt finns i den servicespecifika dokumentationen.

Hur anger jag att ett JSON-fält ska uppdateras i en PATCH-begäran? how-do-i-indicate-a-json-field-to-update-in-a-patch-request

Många PATCH-åtgärder i Platform API:er använder JSON-pekarsträngarför att ange att JSON-egenskaper ska uppdateras. Dessa inkluderas vanligtvis i begärandenyttolaster med formatet JSON Patch. I guiden Grundläggande APIfinns detaljerad information om nödvändig syntax för dessa tekniker.

Kan jag använda Postman för att ringa anrop till Platform API:er? how-do-i-use-postman-to-make-calls-to-platform-apis

Postman är ett användbart verktyg för att visualisera anrop till RESTful API:er. Guiden Komma igång-guide för plattforms-API innehåller en video och instruktioner för hur du importerar Postman-samlingar. Dessutom finns en lista över Postman-samlingar för varje tjänst.

Vilka är systemkraven för Platform? what-are-the-system-requirements-for-platform

Beroende på om du använder gränssnittet eller API:t gäller följande systemkrav:

För gränssnittsbaserade åtgärder:

För API- och utvecklarinteraktioner:

Fel och felsökning errors-and-troubleshooting

Nedan följer en lista över fel som kan uppstå när du använder någon Experience Platform-tjänst. Felsökningsguider för enskilda Platform-tjänster finns i tjänstens felsökningskatalog nedan.

API-statuskoder api-status-codes

Följande statuskoder kan påträffas i alla Experience Platform-API:er. Det finns en mängd orsaker till detta, och därför är de förklaringar som ges i detta avsnitt av allmän karaktär. Mer information om specifika fel i enskilda Platform-tjänster finns i tjänstens felsökningskatalog nedan.

Fel i begärandehuvud request-header-errors

Alla API-anrop i Platform kräver specifika begäranderubriker. Om du vill se vilka huvuden som krävs för enskilda tjänster kan du läsa API-referensdokumentationen. Information om hur du hittar värden för de autentiseringshuvuden som krävs finns i Autentiseringssjälvstudiekursen. Om någon av dessa rubriker saknas eller är ogiltig när ett API-anrop görs kan följande fel uppstå.

OAuth-token saknas oauth-token-is-missing

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

Det här felmeddelandet visas när ett Authorization-huvud saknas i en API-begäran. Kontrollera att auktoriseringshuvudet ingår i en giltig åtkomsttoken innan du försöker igen.

OAuth-token är inte giltig oauth-token-is-not-valid

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

Det här felmeddelandet visas när den angivna åtkomsttoken i huvudet Authorization inte är giltig. Kontrollera att token har angetts korrekt eller generera en ny token i Adobe I/O Console.

API-nyckel krävs api-key-is-required

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

Det här felmeddelandet visas när en API-nyckelrubrik (x-api-key) saknas i en API-begäran. Kontrollera att rubriken är inkluderad med en giltig API-nyckel innan du försöker igen.

API-nyckeln är ogiltig api-key-is-invalid

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

Det här felmeddelandet visas när värdet för det angivna API-nyckelhuvudet (x-api-key) är ogiltigt. Kontrollera att du har angett nyckeln korrekt innan du försöker igen. Om du inte känner till din API-nyckel kan du hitta den i Adobe I/O-konsolen: på fliken Integrationer navigerar du till avsnittet Översikt för att hitta en specifik integrering och söker efter API-nyckeln under Klientautentiseringsuppgifter.

Rubrik saknas missing-header

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

Det här felmeddelandet visas när ett organisationshuvud (x-gw-ims-org-id) saknas i en API-begäran. Se till att rubriken är inkluderad i din organisations ID innan du försöker igen.

Profilen är ogiltig profile-is-not-valid

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

Det här felmeddelandet visas när integreringen av användaren eller Adobe I/O (identifieras av åtkomsttoken i rubriken Authorization) inte har rätt att göra anrop till Experience Platform API:er för organisationen som anges i rubriken x-gw-ims-org-id. Kontrollera att du har angett rätt ID för din organisation i huvudet innan du försöker igen. Om du inte känner till ditt organisations-ID hittar du det i Adobe I/O Console: på fliken Integrationer navigerar du till avsnittet Översikt för att hitta ett specifikt integrationsnamn under Klientautentiseringsuppgifter.

Fel vid uppdatering av tagg refresh-etag-error

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

Du kan få ett taggfel om en ändring har gjorts för en käll- eller målenhet, t.ex. flöde, anslutning, källkoppling eller målanslutning av en annan API-anropare. På grund av versionsmatchningsfelet tillämpas inte den ändring du försöker göra på den senaste versionen av entiteten.

För att lösa detta måste du hämta entiteten igen, se till att dina ändringar är kompatibla med den nya versionen av entiteten, sedan placera den nya taggen i rubriken If-Match och slutligen göra API-anropet.

Giltig innehållstyp har inte angetts valid-content-type-not-specified

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

Det här felmeddelandet visas när en POST-, PUT eller PATCH-begäran har ett ogiltigt eller saknat Content-Type-huvud. Kontrollera att rubriken ingår i begäran och att dess värde är application/json.

Användarregion saknas user-region-is-missing

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

Det här felmeddelandet visas i något av följande två fall:

Felsökningskatalog för tjänst service-troubleshooting-directory

Nedan följer en lista över felsökningsguider och API-referensdokumentation för Experience Platform API:er. Varje felsökningsguide ger svar på vanliga frågor och lösningar på problem som är specifika för enskilda Platform-tjänster. API-referensdokumenten innehåller en omfattande guide till alla tillgängliga slutpunkter för varje tjänst och visar exempel på begärandetexter, svar och felkoder som du kan få.