Creare un ServiceNow connettore utilizzando l' Flow Service API

Nota

Il ServiceNow connettore è in versione beta. Per ulteriori informazioni sull'utilizzo dei connettori con etichetta beta, consulta la panoramica Origini.

Flow Service viene utilizzato per raccogliere e centralizzare i dati dei clienti da varie origini all'interno di Adobe Experience Platform. Il servizio fornisce un'interfaccia utente e RESTful API da cui sono collegate tutte le origini supportate.

Questa esercitazione utilizza l' Flow Service API per illustrare i passaggi necessari per connettersi Experience Platform a un ServiceNow server.

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Origini: Experience Platform consente l'acquisizione di dati da varie origini, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo tramite Platform i servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che dividono una singola Platform istanza in ambienti virtuali separati per sviluppare e sviluppare applicazioni per esperienze digitali.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per collegarsi correttamente a un ServiceNow server tramite l' Flow Service API.

Raccogli credenziali richieste

Per Flow Service collegarsi a ServiceNow, è necessario fornire valori per le seguenti proprietà di connessione:

Credenziali Descrizione
endpoint L'endpoint del ServiceNow server.
username Il nome utente utilizzato per connettersi al ServiceNow server per l'autenticazione.
password La password per connettersi al ServiceNow server per l'autenticazione.

Per ulteriori informazioni su come iniziare, consulta questo documentodi ServiceNow.

Lettura di chiamate API di esempio

Questa esercitazione fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, vedete la sezione come leggere chiamate API di esempio nella guida alla Experience Platform risoluzione dei problemi.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle Platform API, è prima necessario completare l'esercitazione sull'autenticazione. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate Experience Platform API, come illustrato di seguito:

  • Autorizzazione: Portatore {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Tutte le risorse in Experience Platform, comprese quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle Platform API richiedono un'intestazione che specifica il nome della sandbox in cui avrà luogo l'operazione:

  • x-sandbox-name: {SANDBOX_NAME}

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione aggiuntiva per il tipo di supporto:

  • Content-Type: application/json

Cercare le specifiche di connessione

Per creare una ServiceNow connessione, è necessario che all'interno di ServiceNow sia presente una serie di specifiche di Flow Serviceconnessione. Il primo passo per collegarsi Platform a ServiceNow è recuperare queste specifiche.

Formato API

Ogni origine disponibile dispone di un proprio set di specifiche di connessione per descrivere le proprietà del connettore, ad esempio i requisiti di autenticazione. L’invio di una richiesta di GET all’ /connectionSpecs endpoint restituirà le specifiche di connessione per tutte le origini disponibili. È inoltre possibile includere la query property=name=="service-now" per ottenere informazioni specifiche per ServiceNow.

GET /connectionSpecs
GET /connectionSpecs?property=name=="service-now"

Richiesta

La richiesta seguente recupera le specifiche di connessione per ServiceNow.

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="service-now"' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Risposta

Una risposta corretta restituisce le specifiche di connessione per ServiceNow, incluso il relativo identificatore univoco (id). Questo ID è richiesto nel passaggio successivo per creare una connessione di base.

{
    "items": [
        {
            "id": "eb13cb25-47ab-407f-ba89-c0125281c563",
            "name": "service-now",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to ServiceNow server",
                        "properties": {
                            "endpoint": {
                                "type": "string",
                                "description": "The endpoint of the ServiceNow server (http://<instance>.service-now.com)."
                            },
                            "username": {
                                "type": "string",
                                "description": "The user name used to connect to the ServiceNow server for authentication."
                            },
                            "password": {
                                "type": "string",
                                "description": "password to connect to the ServiceNow server for authentication.",
                                "format": "password"
                            }
                        },
                        "required": [
                            "endpoint",
                            "username",
                            "password"
                        ]
                    }
                }
            ],
        }
    ]
}

Creazione di una connessione di base

Una connessione di base specifica un'origine e contiene le credenziali per tale origine. È necessaria una sola connessione di base per ServiceNow account, in quanto può essere utilizzata per creare più connettori sorgente per inserire dati diversi.

Formato API

POST /connections

Richiesta

curl -X POST \
    'http://platform.adobe.io/data/foundation/flowservice/connections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Base connection for service-now",
        "description": "Base connection for service-now,
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                "endpoint": "{ENDPOINT}",
                "username": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "eb13cb25-47ab-407f-ba89-c0125281c563",
            "version": "1.0"
        }
    }'
Proprietà Descrizione
auth.params.server L'endpoint del ServiceNow server.
auth.params.username Il nome utente utilizzato per connettersi al ServiceNow server per l'autenticazione.
auth.params.password La password per connettersi al ServiceNow server per l'autenticazione.
connectionSpec.id ID specifica di connessione associato a ServiceNow.

Risposta

Una risposta corretta restituisce i dettagli della connessione di base appena creata, incluso il relativo identificatore univoco (id). Questo ID è necessario per esplorare CRM nel passaggio successivo.

{
    "id": "8a3ca3dd-6d00-4c95-bca3-dd6d00dc954b",
    "etag": "\"8e0052a2-0000-0200-0000-5e25fb330000\""
}

Passaggi successivi

Seguendo questa esercitazione, hai creato una connessione di ServiceNow base utilizzando l' Flow Service API e hai ottenuto il valore ID univoco della connessione. Puoi usare questo ID connessione di base nell'esercitazione successiva per scoprire come esplorare i sistemi di successo dei clienti tramite l'APIdel servizio di flusso.

In questa pagina