DokumentationExperience PlatformAnvändarhandbok om destinationer

Hämta en konfiguration för autentiseringsuppgifter

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Administratör
  • Användare
IMPORTANT
API-slutpunkt: platform.adobe.io/data/core/activation/authoring/credentials

Den här sidan innehåller exempel på API-begäran och nyttolast som du kan använda för att hämta en autentiseringskonfiguration med API-slutpunkten /authoring/credentials.

När API-slutpunkten /credentials ska användas when-to-use

IMPORTANT
I de flesta fall behöver du inte använda API-slutpunkten /credentials. I stället kan du konfigurera autentiseringsinformationen för målet via customerAuthenticationConfigurations-parametrarna för slutpunkten /destinations.
Läs Konfiguration för kundautentisering om du vill ha mer information om vilka autentiseringstyper som stöds.

Använd den här API-slutpunkten om du bara vill skapa en autentiseringskonfiguration om det finns ett globalt autentiseringssystem mellan Adobe och målplattformen, och Platform-kunden inte behöver ange några autentiseringsuppgifter för att ansluta till målet. I det här fallet måste du skapa en autentiseringskonfiguration med API-slutpunkten /credentials.

När du använder ett globalt autentiseringssystem måste du ange "authenticationRule":"PLATFORM_AUTHENTICATION" i konfigurationen för målleverans när du skapar en ny målkonfiguration.

IMPORTANT
Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänsliga. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.

Komma igång med API-åtgärder för autentiseringsuppgifter get-started

Innan du fortsätter bör du läsa igenom kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive hur du får nödvändig behörighet för målredigering och nödvändiga rubriker.

Hämta en konfiguration för autentiseringsuppgifter retrieve

Du kan hämta en befintlig-autentiseringskonfiguration genom att göra en GET-begäran till /authoring/credentials-slutpunkten.

API-format

Använd följande API-format för att hämta alla autentiseringskonfigurationer för ditt konto.

GET /authoring/credentials

Använd följande API-format för att hämta en specifik autentiseringskonfiguration som definieras av parametern {INSTANCE_ID}.

GET /authoring/credentials/{INSTANCE_ID}

Följande två begäranden hämtar alla autentiseringskonfigurationer för din IMS-organisation, eller en specifik autentiseringskonfiguration, beroende på om du skickar parametern INSTANCE_ID i begäran.

Välj varje flik nedan för att visa motsvarande nyttolast.

Hämta alla autentiseringskonfigurationer
accordion
Begäran
code language-shell 
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
accordion
svar

Ett lyckat svar returnerar HTTP-status 200 med en lista över autentiseringskonfigurationer som du har åtkomst till, baserat på det IMS Org ID- och sandlådenamn som du använde. En instanceId motsvarar en autentiseringskonfiguration.

code language-json 
{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
},
{
   "instanceId":"a25bffa0-3127-4030-895d-1d1236bb3680",
   "createdDate":"2022-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2022-08-07T06:41:48.641943Z",
   "type":"basic",
   "name":"yourdestination",
   "s3Authentication":{
      "url":"string",
      "username":"string",
      "password":"string"
   }
}
Hämta en specifik autentiseringskonfiguration
accordion
Begäran
code language-shell 
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
table 0-row-2 1-row-2
Parameter Beskrivning
{INSTANCE_ID} ID:t för den autentiseringskonfiguration som du vill hämta.
accordion
svar

Ett lyckat svar returnerar HTTP-status 200 med information om autentiseringskonfigurationen som motsvarar instanceId som anges i begäran.

code language-json 
{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}

API-felhantering error-handling

Destination SDK-API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och begäranrubrikfel i felsökningsguiden för plattformen.

Nästa steg next-steps

När du har läst det här dokumentet vet du nu hur du hämtar information om dina autentiseringskonfigurationer med API-slutpunkten /authoring/credentials. Läs om hur du använder Destination SDK för att konfigurera ditt mål och förstå var det här steget passar in i processen att konfigurera ditt mål.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6