Show Menu
ARGOMENTI×

API esterna

Descrizione

L' External API attività porta i dati nel flusso di lavoro da un sistema esterno tramite una chiamata API REST.
Gli endpoint REST possono essere un sistema di gestione dei clienti, un'istanza Runtime I/O di Adobe o un endpoint REST di Experience Cloud (Piattaforma dati, Target, Analytics, Campaign, ecc.).
Per motivi di sicurezza, l'utilizzo di JSSP non è supportato in Campaign Standard. Se è necessario eseguire il codice, potete chiamare un'istanza runtime di I/O Adobe tramite l'attività API esterna.
Questa funzionalità è attualmente nella versione beta pubblica. Prima di iniziare a utilizzare l'attività API esterna, dovete accettare l'accordo di utilizzo. Nota: poiché questa funzionalità beta pubblica non è ancora stata rilasciata in commercio da Adobe, non è supportata da Adobe Client Care, potrebbe contenere errori e potrebbe non funzionare come altre funzionalità rilasciate.
Le principali caratteristiche di questa attività sono:
  • Possibilità di trasmettere dati in formato JSON a un endpoint API REST di terze parti
  • Possibilità di ricevere una risposta JSON indietro, mapparla alle tabelle di output e passare a valle ad altre attività del flusso di lavoro.
  • Gestione degli errori con una transizione specifica in uscita
Per questa attività sono stati istituiti i seguenti presidi:
  • Limite dimensione dati risposta HTTP 5 MB
  • Timeout richiesta: 60 secondi
  • Reindirizzamenti HTTP non consentiti
  • Gli URL non HTTPS vengono rifiutati
  • "Accetta: header della richiesta application/json" e "Content-Type: l'intestazione della risposta application/json" è consentita
Nota che l'attività è destinata al recupero di dati a livello di campagna (ultimi set di offerte, ultimi punteggi ecc.) non per il recupero di informazioni specifiche per ciascun profilo, in quanto ciò può comportare il trasferimento di grandi quantità di dati. Se il caso d'uso lo richiede, la raccomandazione consiste nell'utilizzare l'attività Trasferisci file .

Configurazione

Trascinate e rilasciate un' External API attività nel flusso di lavoro e aprite l'attività per avviare la configurazione.

Mapping in entrata

La mappatura in entrata è una tabella temporanea generata da un'attività in entrata precedente che verrà visualizzata e inviata come JSON nell'interfaccia utente. In base a questa tabella temporanea, l'utente può apportare modifiche ai dati in entrata.
Il menu a discesa delle risorse in entrata consente di selezionare l'attività di query che creerà la tabella temporanea.
La casella di controllo Aggiungi parametro di conteggio fornirà un valore di conteggio per ogni riga proveniente dalla tabella temporanea. Questa casella di controllo è disponibile solo se l'attività in entrata genera una tabella temporanea.
La sezione Colonne in entrata consente all'utente di aggiungere qualsiasi campo dalla tabella di transizione in entrata. Le colonne selezionate saranno le chiavi nell'oggetto dati. L'oggetto dati nel JSON sarà un elenco di array contenente i dati per le colonne selezionate da ogni riga della tabella di transizione in entrata.
La casella di testo Personalizza parametro consente di aggiungere un JSON valido con dati aggiuntivi richiesti dall'API esterna. Questi dati aggiuntivi verranno aggiunti all'oggetto params nel JSON generato.

Mapping in uscita

Questa scheda consente di definire la struttura JSON di esempio restituita dalla chiamata API.
Il pattern di struttura JSON è: {“data”:[{“key”:“value”}, {“key”:“value”},...]}
La definizione JSON di esempio deve avere le seguenti caratteristiche :
  • data è un nome di proprietà obbligatorio nel JSON, il contenuto di "data" è un array JSON.
  • Gli elementi array devono contenere proprietà di primo livello (i livelli più profondi non sono supportati). I nomi delle proprietà finirebbero per diventare nomi di colonna per lo schema di output della tabella temporanea di output.
  • La definizione del nome della colonna è basata sul primo elemento dell'array "data". La definizione delle colonne (aggiungere/rimuovere) e il valore del tipo della proprietà possono essere modificati nella scheda Definizione colonna.
Se l' analisi viene convalidata , viene visualizzato un messaggio e si invita a personalizzare la mappatura dei dati nella scheda "Definizione colonna". In altri casi, viene visualizzato un messaggio di errore.

Esecuzione

Questa scheda consente di definire l'endpoint HTTPS che invierà i dati ad ACS. Se necessario, potete immettere le informazioni di autenticazione nei campi seguenti.

Proprietà

Questa scheda consente di controllare le proprietà generali dell'attività API esterna, come l'etichetta visualizzata nell'interfaccia utente. L'ID interno non è personalizzabile.

Definizione colonna

Questa scheda viene visualizzata quando il formato dei dati della risposta viene completato e convalidato nella scheda Mappatura in uscita.
La scheda Definizione colonna consente di specificare con precisione la struttura di dati di ogni colonna al fine di importare dati che non contengono errori e di farli corrispondere ai tipi già presenti nel database Adobe Campaign per le operazioni future.
Ad esempio, è possibile modificare l'etichetta di una colonna, selezionarne il tipo (stringa, numero intero, data, ecc.) oppure specificare l'elaborazione degli errori.
Per ulteriori informazioni, consultare la sezione Carica file .

Transizione

Questa scheda consente di attivare la transizione in uscita e la relativa etichetta. Questa transizione specifica è utile in caso di timeout o se il payload supera il limite di dimensione dei dati.

Opzioni di esecuzione

Questa scheda è disponibile nella maggior parte delle attività del flusso di lavoro. Per ulteriori informazioni, consulta la sezione Proprietà Proprietà dell'attività attività.

Risoluzione dei problemi

Esistono due tipi di messaggi di registro aggiunti a questa nuova attività del flusso di lavoro: informazioni ed errori. Possono essere utili per risolvere eventuali problemi.

Informazioni

Questi messaggi di registro vengono utilizzati per registrare informazioni su punti di controllo utili durante l'esecuzione dell'attività del flusso di lavoro. In modo specifico, i messaggi di registro seguenti vengono utilizzati per registrare il primo tentativo e il tentativo di effettuare un nuovo tentativo (motivo del primo tentativo non riuscito) di accedere all'API.
Formato messaggio Esempio
Richiamo dell'URL API '%s'.
Richiamo dell'URL API 'https://example.com/api/v1/web-coupon?count=2'.
Nuovo URL API '%s'. Tentativo precedente non riuscito ('%s').
Nuovo URL API 'https://example.com/api/v1/web-coupon?count=2', tentativo precedente non riuscito ('HTTP - 401').
Trasferimento del contenuto da '%s' (%s / %s).
Trasferimento di contenuti da 'https://example.com/api/v1/web-coupon?count=2' (1234 / 1234).

Errori

Questi messaggi di registro vengono utilizzati per registrare informazioni sulle condizioni di errore impreviste, che possono causare il fallimento dell'attività del flusso di lavoro.
Codice - Formato messaggio Esempio
WKF-560250: limite superato per il corpo della richiesta API (limite: '%d').
Limite superato del corpo della richiesta API (limite: '5242880').
WKF-560239: limite di risposta API superato (limite: '%d').
Limite di risposta API superato (limite: 5242880').
WKF-560245: impossibile analizzare l'URL API (errore: '%d').
Impossibile analizzare l'URL API (errore: '-2010').
Nota: Questo errore viene registrato quando l'URL API non supera le regole di convalida.
WKF-560244: l'host dell'URL API non deve essere 'localhost' o letterale di indirizzo IP (host URL: '%s').
L'host dell'URL API non deve essere 'localhost' o letterale di indirizzo IP (host URL: 'localhost').
L'host dell'URL API non deve essere 'localhost' o letterale di indirizzo IP (host URL: '192.168.0.5').
L'host dell'URL API non deve essere 'localhost' o letterale di indirizzo IP (host URL: "[2001]").
WKF-560238 - L'URL API deve essere un URL protetto (https) (URL richiesto: '%s').
L'URL API deve essere un URL protetto (https) (URL richiesto: "https://example.com/api/v1/web-coupon?count=2').
WKF-560249: impossibile creare il corpo della richiesta JSON. Errore durante l'aggiunta di '%s'.
Impossibile creare il corpo della richiesta JSON. Errore durante l'aggiunta di 'params'.
Impossibile creare il corpo della richiesta JSON. Errore durante l'aggiunta di 'data'.
WKF-560246 - Chiave di intestazione HTTP non valida (chiave di intestazione: '%s').
Chiave di intestazione HTTP non valida (chiave di intestazione: '%s').
Nota: Questo errore viene registrato quando la chiave di intestazione personalizzata non supera la convalida secondo RFC
WKF-560248 - Chiave di intestazione HTTP non consentita (chiave di intestazione: '%s').
La chiave di intestazione HTTP non è consentita (chiave di intestazione: 'Accetto').
WKF-560247 - Il valore dell'intestazione AHTTP è errato (valore dell'intestazione: '%s').
Il valore dell'intestazione HTTP è errato (valore dell'intestazione: '%s').
Nota: Questo errore viene registrato quando il valore dell'intestazione personalizzata non supera la convalida secondo RFC
WKF-560240 - Il payload JSON ha una proprietà non valida '%s'.
Il payload JSON ha una proprietà "blah" non valida.
WKF-560241 - JSON non valido o formato inaccettabile.
JSON non valido o formato non valido.
Nota: Questo messaggio si applica solo all'analisi del corpo della risposta dall'API esterna e viene registrato quando si tenta di convalidare la conformità del corpo della risposta al formato JSON richiesto da questa attività.
WKF-560246 - Attività non riuscita (motivo: '%s').
Quando l'attività non riesce a causa di una risposta di errore HTTP 401 - Attività non riuscita (motivo: 'HTTP - 401')
Quando l'attività non riesce a causa di una chiamata interna non riuscita - Attività non riuscita (motivo: 'iRc - -Nn').
Quando l'attività non riesce a causa di un'intestazione Content-Type non valida. - Attività non riuscita (motivo: 'Content-Type - application/html').