Crear una conexión base PathFactory mediante la API Flow Service

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

Temas:

Creado para:

Desarrollador

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Lea este documento para aprender a crear una conexión base para PathFactory mediante la [Flow Service API] (https://www.adobe.io/experience-platform-apis/references/flow-service/).

Introducción

Esta guía requiere una comprensión práctica de los siguientes componentes de Experience Platform:

Fuentes: El Experience Platform permite la ingesta de datos de varias fuentes, al tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
Zonas protegidas: El Experience Platform proporciona zonas protegidas virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Uso de API de Platform

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía sobre introducción a las API de Platform.

La siguiente sección proporciona información adicional que necesitará conocer para conectarse correctamente a PathFactory mediante la API Flow Service.

Recopilar credenciales necesarias gather-credentials

Para acceder a su cuenta de PathFactory en Platform, debe proporcionar los siguientes valores:

Credencial

Descripción

Nombre de usuario

Su nombre de usuario de la cuenta PathFactory. Esto es esencial para identificar su cuenta en el sistema.

Contraseña

La contraseña asociada a su cuenta de PathFactory. Asegúrese de que se mantenga seguro para evitar el acceso no autorizado.

Dominio

El dominio asociado con su cuenta de PathFactory. Esto generalmente hace referencia al identificador único dentro de la dirección URL PathFactory.

Token de acceso

Un token único usado para la autenticación de API a fin de asegurar la comunicación segura entre sus sistemas y PathFactory.

Extremos de API

Puntos finales específicos de API para acceder a los datos: visitantes, sesiones y vistas de páginas. Cada extremo corresponde a diferentes conjuntos de datos que puede recuperar. Nota: Están predefinidos por PathFactory y son específicos de los datos a los que desea tener acceso:

Extremo de visitantes: /api/public/v3/data_lake_apis/visitors.json
Punto final de sesiones: /api/public/v3/data_lake_apis/sessions.json
Extremo de vistas de página: /api/public/v3/data_lake_apis/page_views.json

Para obtener más información sobre cómo proteger y usar sus credenciales, y cómo obtener y actualizar su token de acceso, visite el PathFactory Centro de soporte técnico. Este recurso ofrece guías completas sobre la administración de las credenciales y la garantía de una integración de API eficaz y segura.

Crear una conexión base

Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear un identificador de conexión base, realice una solicitud de POST al extremo /connections y proporcione sus credenciales de autenticación PathFactory como parte del cuerpo de la solicitud.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para PathFactory:

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "PathFactory base connection",
      "description": "PathFactory base connection",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "host": "acme-ab12c3d4e5fg6hijk7lmnop8qrst"
              "clientId": "pathfactory",
              "clientSecret": "xxxx"
          }
      },
      "connectionSpec": {
          "id": "ea1c2a08-b722-11eb-8529-0242ac130003",
          "version": "1.0"
      }
  }'

Propiedad

Descripción

auth.params.clientId

Identificador de cliente asociado con la aplicación PathFactory.

auth.params.clientSecret

Secreto de cliente asociado a la aplicación PathFactory.

connectionSpec.id

Identificador de especificación de conexión PathFactory: ea1c2a08-b722-11eb-8529-0242ac130003.

Respuesta

Una respuesta correcta devuelve la conexión recién creada, incluido su identificador de conexión único (id). Este ID es necesario para explorar los datos en el siguiente tutorial.

{
    "id": "2fce94c1-9a93-4971-8e94-c19a93097129",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión base PathFactory mediante la API Flow Service. Puede utilizar este ID de conexión base en los siguientes tutoriales:

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089