Recuperare una configurazione di credenziali

IMPORTANT
Endpoint API: platform.adobe.io/data/core/activation/authoring/credentials

Questa pagina esemplifica la richiesta API e il payload che è possibile utilizzare per recuperare una configurazione di credenziali utilizzando /authoring/credentials Endpoint API

Quando utilizzare il /credentials Endpoint API when-to-use

IMPORTANT
Nella maggior parte dei casi, non devono utilizzare /credentials Endpoint API È invece possibile configurare le informazioni di autenticazione per la destinazione tramite customerAuthenticationConfigurations parametri di /destinations endpoint.
Letto Configurazione autenticazione cliente per informazioni dettagliate sui tipi di autenticazione supportati.

Utilizzare questo endpoint API per creare una configurazione di credenziali solo se esiste un sistema di autenticazione globale tra Adobe e la piattaforma di destinazione e Platform Il cliente non deve fornire credenziali di autenticazione per connettersi alla destinazione. In questo caso, è necessario creare una configurazione delle credenziali utilizzando /credentials Endpoint API

Quando si utilizza un sistema di autenticazione globale, è necessario impostare "authenticationRule":"PLATFORM_AUTHENTICATION" nel consegna di destinazione configurazione, quando creazione di una nuova configurazione di destinazione.

IMPORTANT
Tutti i nomi e i valori dei parametri supportati da Destination SDK sono distinzione maiuscole/minuscole. Per evitare errori di distinzione tra maiuscole e minuscole, utilizza i nomi e i valori dei parametri esattamente come mostrato nella documentazione.

Guida introduttiva alle operazioni API per le credenziali get-started

Prima di continuare, controlla guida introduttiva per informazioni importanti che è necessario conoscere per effettuare correttamente chiamate all’API, tra cui come ottenere l’autorizzazione di authoring della destinazione richiesta e le intestazioni richieste.

Recuperare una configurazione di credenziali retrieve

È possibile recuperare un esistente configurazione delle credenziali effettuando una GET richiesta al /authoring/credentials endpoint.

Formato API

Utilizza il seguente formato API per recuperare tutte le configurazioni di credenziali per il tuo account.

GET /authoring/credentials

Utilizza il seguente formato API per recuperare una configurazione credenziale specifica, definita da {INSTANCE_ID} parametro.

GET /authoring/credentials/{INSTANCE_ID}

Le due richieste seguenti recuperano tutte le configurazioni di credenziali per l’organizzazione IMS o una configurazione di credenziali specifica, a seconda che venga passata o meno la INSTANCE_ID nella richiesta.

Seleziona ciascuna scheda di seguito per visualizzare il payload corrispondente.

Recupera tutte le configurazioni di credenziali
accordion
Richiesta
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
Risposta

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con un elenco di configurazioni di credenziali a cui hai accesso, in base al IMS Org ID e il nome della sandbox che hai utilizzato. Uno instanceId corrisponde a una configurazione di credenziali.

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"
   }
}
Recuperare una configurazione delle credenziali specifica
accordion
Richiesta
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
Parametro Descrizione
{INSTANCE_ID} ID della configurazione delle credenziali da recuperare.
accordion
Risposta

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della configurazione delle credenziali corrispondenti al instanceId fornite sulla richiesta.

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"
   }
}

Gestione degli errori API error-handling

Gli endpoint API di Destination SDK seguono i principi generali dei messaggi di errore API di Experience Platform. Fai riferimento a Codici di stato API e errori di intestazione della richiesta nella guida alla risoluzione dei problemi di Platform.

Passaggi successivi next-steps

Dopo aver letto questo documento, ora sai come recuperare i dettagli sulle configurazioni delle credenziali utilizzando /authoring/credentials Endpoint API Letto come utilizzare Destination SDK per configurare la destinazione per capire in che modo questo passaggio si inserisce nel processo di configurazione della destinazione.

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