Platform Vanliga frågor och felsökningsguide

Det här dokumentet innehåller svar på vanliga frågor om Adobe Experience Platform samt en guide på hög nivå om vanliga fel som kan uppstå i Experience Platform API. Felsökningsguider för enskilda användare Platform tjänster, se tjänstfelsö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? what-are-experience-platform-apis

Experience Platform erbjuder flera RESTful-API:er som använder HTTP-begäranden för åtkomst 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-referensdokumentation på Adobe I/O.

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

Format varierar beroende på Platform API används. Det bästa sättet att lära sig att strukturera API-anrop är att följa med exemplen i dokumentationen för det aktuella Platform tjänster som du använder.

Mer information om hur du formaterar API-begäranden finns i guiden Komma igång-guide för plattforms-API läsa exempel-API-anrop -avsnitt.

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 har rätt att Experience Platformkan den ge utvecklare åtkomst. Organisations-ID (x-gw-ims-org-id) representerar organisationen som ett API-anrop ska köras för och därför krävs som huvud i alla API-begäranden. Detta ID finns via Adobe Developer Console: i Integreringar flik, navigera till Ökning för en viss integrering för att hitta ID:t under Klientautentiseringsuppgifter. En stegvis genomgång av hur man autentiserar sig Platform, se självstudiekurs om 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 finns på Adobe Developer Console. I konsolen, på Integreringar flik, navigera till Ökning för en viss integrering och du hittar nyckeln under Klientautentiseringsuppgifter. En stegvis genomgång av hur man autentiserar Platform, se självstudiekurs om 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älvstudiekurs om autentisering.

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

Några Platform API-slutpunkter accepterar frågeparametrar för att hitta specifik information och filtrera resultaten som returneras i svaret. Frågeparametrar läggs till i sökvägar med 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-pekare strängar som anger JSON-egenskaper som ska uppdateras. Dessa inkluderas vanligtvis i begärandenyttolaster som använder JSON Patch format. Se Grundläggande API-guide för detaljerad information om nödvändig syntax för dessa tekniker.

Kan jag använda Postman för att ringa Platform API? 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. The Starthandbok för att komma igång med 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 UI-baserade åtgärder:

  • En modern standardwebbläsare. Medan den senaste versionen av Chrome rekommenderas, aktuella och tidigare större versioner av Firefox, Internet Exploreroch Safari stöds också.
    • Varje gång en ny större version släpps, Platform har stöd för den senaste versionen medan stöd för den tredje senaste versionen har tagits bort.
  • Alla webbläsare måste ha cookies och JavaScript aktiverat.

För API- och utvecklarinteraktioner:

  • En utvecklingsmiljö som ska utvecklas för integrering av REST, strömning och Webkrok.

Fel och felsökning errors-and-troubleshooting

Nedan följer en lista över fel som du kan råka ut för när du använder Experience Platform service. Felsökningsguider för enskilda användare Platform tjänster, se tjänstfelsökningskatalog nedan.

API-statuskoder api-status-codes

Följande statuskoder kan påträffas på alla Experience Platform API. 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 fall Platform tjänster, se tjänstfelsökningskatalog nedan.

Statuskod
Beskrivning
Möjliga orsaker
400
Felaktig begäran
Begäran var felaktigt konstruerad, saknade nyckelinformation och/eller innehöll felaktig syntax.
401
Autentiseringen misslyckades
Begäran klarade inte en autentiseringskontroll. Åtkomsttoken kanske saknas eller är ogiltig. Se OAuth-tokenfel för mer information.
403
Förbjuden
Resursen hittades, men du har inte rätt autentiseringsuppgifter för att visa den.
En trolig orsak till det här felet är att du kanske inte har den nödvändiga behörigheter för åtkomstkontroll för att få åtkomst till eller redigera resursen. Läs om få de nödvändiga attributbaserade behörigheterna för åtkomstkontroll för att använda plattforms-API:er.
404
Hittades inte
Det gick inte att hitta den begärda resursen på servern. Resursen kan ha tagits bort eller så har den begärda sökvägen angetts felaktigt.
500
Internt serverfel
Det här är ett serverfel. Om du gör många samtidiga anrop kanske du når API-gränsen och behöver filtrera resultaten. (Se Catalog Service Utvecklarhandbok för API på filtrera data om du vill veta mer.) Vänta en stund innan du försöker utföra din begäran igen och kontakta administratören om problemet kvarstår.

Fel i begärandehuvud request-header-errors

Alla API-anrop Platform kräver särskilda begäranrubriker. Om du vill se vilka huvuden som krävs för enskilda tjänster kan du gå till API-referensdokumentation. Information om hur du hittar värdena för de obligatoriska autentiseringshuvudena finns i Självstudiekurs om autentisering. 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 en 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 finns i Authorization header is not valid. 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 ett API-nyckelhuvud (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 den angivna API-nyckelrubriken (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 Console: i Integreringar flik, navigera till Ökning för en specifik integrering för att hitta 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 mellan användare och Adobe I/O (identifieras av åtkomsttoken i Authorization header) inte har rätt att ringa Experience Platform API:er för organisationen som anges i x-gw-ims-org-id header. 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 kan du hitta det i Adobe I/O Console: i Integreringar flik, navigera till Ökning för en specifik integrering för att hitta ID:t 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 enheten igen, se till att dina ändringar är kompatibla med den nya versionen av enheten och sedan placera den nya taggen i If-Match och anropa slutligen API.

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 saknar eller är ogiltig Content-Type header. Kontrollera att rubriken är inkluderad 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:

  • När ett fel eller ett felaktigt format organisations-ID-huvud (x-gw-ims-org-id) skickas i en API-begäran. Kontrollera att rätt ID för din organisation finns med innan du försöker igen.
  • När ditt konto (som representeras av de angivna autentiseringsuppgifterna) inte är associerat med en produktprofil för Experience Platform. Följ stegen på generera autentiseringsuppgifter i självstudiekursen för autentisering av plattforms-API för att lägga till plattform i ditt konto och uppdatera dina autentiseringsuppgifter i enlighet med detta.

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

Här följer en lista med felsökningsguider och API-referensdokumentation för Experience Platform API. Varje felsökningsguide ger svar på vanliga frågor och lösningar på problem som är specifika för enskilda användare 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å.

Tjänst
API-referens
Felsökning
Åtkomstkontroll
API för åtkomstkontroll
Felsökningsguide för åtkomstkontroll
Adobe Experience Platform datainmatning
Batch Ingestion API
Felsökningsguide för batchmatning
Adobe Experience Platform datainmatning
Streaming Ingestion API
Felsökningsguide för direktuppspelning
Adobe Experience Platform Data Science Workspace
Sensei Machine Learning API
Data Science Workspace felsökningsguide
Adobe Experience Platform datastyrning
Policy Service API
Adobe Experience Platform Identity Service
Identity Service API
Identity Service felsökningsguide
Adobe Experience Platform Query Service
Query Service API
Query Service felsökningsguide
Adobe Experience Platform Segmentering
Segmentation API
Catalog Service
Catalog Service API
Experience Data Model (XDM)
Schema Registry API
XDM System Vanliga frågor och felsökningsguide
Flow Service (Sources och Destinations)
Flow Service API
Real-Time Customer Profile
Real-Time Customer Profile API
Profile felsökningsguide
Sandlådor
Sandbox-API
Felsökningsguide för sandlådor
recommendation-more-help
5741548a-2e07-44b3-9157-9c181502d0c5