Creare una configurazione delle credenziali

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

Questa pagina esemplifica la richiesta API e il payload che puoi utilizzare per creare 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.

Creare una configurazione di credenziali create

È possibile creare una nuova configurazione delle credenziali eseguendo una POST richiesta al /authoring/credentials endpoint.

Formato API

POST /authoring/credentials

Le seguenti richieste creano nuove configurazioni di credenziali, definite dai parametri forniti nel payload.

Seleziona ciascuna scheda di seguito per visualizzare il payload corrispondente.

Base

Creare una configurazione di base delle credenziali

accordion
Richiesta
code language-shell
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "basicAuthentication":{
      "url":"string",
      "username":"string",
      "password":"string"
   }
}
table 0-row-3 1-row-3 2-row-3 3-row-3 layout-auto
Parametro Tipo Descrizione
url Stringa URL del provider di autorizzazione
username Stringa Nome utente di accesso alla configurazione credenziali
password Stringa Password di accesso alla configurazione delle credenziali
accordion
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della nuova configurazione delle credenziali creata.
Amazon S3

Creare un Amazon S3 configurazione credenziali

accordion
Richiesta
code language-shell
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}
table 0-row-3 1-row-3 2-row-3 layout-auto
Parametro Tipo Descrizione
accessId Stringa Amazon S3 ID accesso
secretKey Stringa Amazon S3 chiave segreta
accordion
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della nuova configurazione delle credenziali creata.
SSH

Creare una configurazione delle credenziali SSH

accordion
Richiesta
code language-shell
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "sshAuthentication":{
      "username":"string",
      "sshKey":"string"
   }
}
table 0-row-3 1-row-3 2-row-3 layout-auto
Parametro Tipo Descrizione
username Stringa Nome utente di accesso alla configurazione credenziali
sshKey Stringa Chiave SSH per SFTP con autenticazione SSH
accordion
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della nuova configurazione delle credenziali creata.
Archiviazione Azure Data Lake

Creare un Azure Data Lake Storage configurazione credenziali

accordion
Richiesta
code language-shell
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "azureAuthentication":{
      "url":"string",
      "tenant":"string",
      "servicePrincipalId":"string",
      "servicePrincipalKey":"string"
   }
}
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 layout-auto
Parametro Tipo Descrizione
url Stringa URL del provider di autorizzazione
tenant Stringa Tenant archiviazione Azure Data Lake
servicePrincipalId Stringa ID entità servizio Azure per l’archiviazione del data lake di Azure
servicePrincipalKey Stringa Chiave principale del servizio Azure per l’archiviazione del data lake di Azure
accordion
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della nuova configurazione delle credenziali creata.
Archiviazione BLOB di Azure

Creare un Azure Blob Storage configurazione credenziali

accordion
Richiesta
code language-shell
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "azureConnectionStringAuthentication":{
      "connectionString":"string"
   }
}
table 0-row-3 1-row-3 layout-auto
Parametro Tipo Descrizione
connectionString Stringa Azure Blob Storage stringa di connessione
accordion
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della nuova configurazione delle credenziali creata.

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 quando utilizzare l’endpoint delle credenziali e come impostare una configurazione delle credenziali utilizzando /authoring/credentials Lettura endpoint API 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