DocumentazioneExperience PlatformGuida alle destinazioni

Recuperare una configurazione di credenziali

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

Creato per:

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

Questa pagina illustra la richiesta API e il payload che è possibile utilizzare per recuperare una configurazione di credenziali utilizzando l'endpoint API /authoring/credentials.

Quando utilizzare l'endpoint API /credentials when-to-use

IMPORTANT
Nella maggior parte dei casi, non deve utilizzare l'endpoint API /credentials. È invece possibile configurare le informazioni di autenticazione per la destinazione tramite i parametri customerAuthenticationConfigurations dell'endpoint /destinations.
Leggi Configurazione autenticazione cliente per informazioni dettagliate sui tipi di autenticazione supportati.

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

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

IMPORTANT
Tutti i nomi e i valori dei parametri supportati da Destination SDK sono con distinzione tra maiuscole e 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, consulta la guida introduttiva per informazioni importanti che devi 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 una configurazione delle credenziali existing effettuando una richiesta GET all'endpoint /authoring/credentials.

Formato API

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

GET /authoring/credentials

Utilizzare il seguente formato API per recuperare una configurazione di credenziali specifica, definita dal parametro {INSTANCE_ID}.

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 si trasmetta o meno il parametro 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 a IMS Org ID e al nome della sandbox utilizzato. Un 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 di 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 fornito nella 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. Consulta 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, saprai come recuperare i dettagli sulle configurazioni delle credenziali utilizzando l'endpoint API /authoring/credentials. Leggi 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