Cree una conexión de base de API de REST genérica usando la variable Flow Service API

NOTA

La variable Generic REST API el origen está en versión beta. Consulte la Resumen de fuentes para obtener más información sobre el uso de conectores con etiqueta beta.

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

Este tutorial le guía por los pasos para crear una conexión base para Generic REST API usando la variable Flow Service API.

Primeros pasos

Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:

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

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

Recopilar las credenciales necesarias

Para Flow Service para conectarse con Generic REST API, debe proporcionar credenciales válidas para el tipo de autenticación que elija. Generic REST API admite tanto el código de actualización de OAuth 2 como la autenticación básica. Consulte las siguientes tablas para obtener información sobre las credenciales de los dos tipos de autenticación admitidos.

Código de actualización de OAuth 2

Credencial Descripción
host La dirección URL de host de la fuente a la que realiza la solicitud. Este valor es obligatorio y no se puede evitar usando requestParameterOverride.
authorizationTestUrl (Opcional) La URL de prueba de autorización se utiliza para validar las credenciales al crear una conexión base. Si no se proporciona, las credenciales se comprueban automáticamente durante el paso de creación de la conexión de origen.
clientId (Opcional) El ID de cliente asociado a su cuenta de usuario.
clientSecret (Opcional) El secreto de cliente asociado a su cuenta de usuario.
accessToken La credencial de autenticación principal utilizada para acceder a su aplicación. El token de acceso representa la autorización de la aplicación para acceder a aspectos concretos de los datos de un usuario. Este valor es obligatorio y no se puede evitar usando requestParameterOverride.
refreshToken (Opcional) Token que se utiliza para generar un nuevo token de acceso cuando el token de acceso ha caducado.
expirationDate (Opcional) Un valor oculto que define la fecha de caducidad del token de acceso.
accessTokenUrl (Opcional) El extremo URL utilizado para recuperar el token de acceso.
requestParameterOverride (Opcional) Una propiedad que le permite especificar qué parámetros de credencial desea anular.
connectionSpec.id La especificación de conexión devuelve las propiedades del conector de un origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y de origen. El ID de especificación de conexión para Generic REST API es: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.

Autenticación básica

Credencial Descripción
host La dirección URL de host de la fuente a la que realiza la solicitud.
username El nombre de usuario que corresponde a su cuenta de usuario.
password La contraseña que corresponde a su cuenta de usuario.
connectionSpec.id La especificación de conexión devuelve las propiedades del conector de un origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y de origen. El ID de especificación de conexión para Generic REST API es: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.

Creación de una conexión base

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

Generic REST API admite autenticación básica y código de actualización de OAuth 2. Consulte los siguientes ejemplos para obtener instrucciones sobre cómo autenticarse con cualquiera de los tipos de autenticación.

Cree un Generic REST API conexión base con código de actualización de OAuth 2

Para crear un ID de conexión base utilizando el código de actualización de OAuth 2, realice una solicitud de POST al /connections al proporcionar sus credenciales de OAuth 2.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para Generic REST API:

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": "Generic REST API base connection with OAuth 2 refresh code",
      "description": "Generic REST API base connection with OAuth 2 refresh code",
      "connectionSpec": {
          "id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
          "version": "1.0"
      },
      "auth": {
          "specName": "oAuth2RefreshCode",
          "params": {
              "host": "{HOST}",
              "accessToken": "{ACCESS_TOKEN}"
          }
      }
  }'
Propiedad Descripción
name Nombre de la conexión base. Asegúrese de que el nombre de la conexión base sea descriptivo, ya que puede utilizarlo para buscar información sobre la conexión base.
description (Opcional) Una propiedad que puede incluir para proporcionar más información sobre la conexión base.
connectionSpec.id El ID de especificación de conexión asociado a Generic REST API. Este ID fijo es: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.
auth.specName El tipo de autenticación que utiliza para autenticar el origen en Platform.
auth.params.host La URL raíz que se usa para conectar con su Generic REST API fuente.
auth.params.accessToken Token de acceso correspondiente utilizado para autenticar el origen. Esto es necesario para la autenticación basada en OAuth.

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 sus datos en el siguiente tutorial.

{
  "id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
  "etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}

Cree un Generic REST API conexión base con autenticación básica

Para crear un Generic REST API conexión base usando autenticación básica, realice una solicitud de POST al /connections punto final de Flow Service al proporcionar sus credenciales de autenticación básicas.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para Generic REST API:

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "Generic REST API base connection with basic authentication",
      "description": "Generic REST API base connection with basic authentication",
      "connectionSpec": {
          "id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
          "version": "1.0"
      },
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "host": "{HOST}",
              "username": "{USERNAME}",
              "password": "{PASSWORD}"
          }
      }
  }'
Propiedad Descripción
name Nombre de la conexión base. Asegúrese de que el nombre de la conexión base sea descriptivo, ya que puede utilizarlo para buscar información sobre la conexión base.
description (Opcional) Una propiedad que puede incluir para proporcionar más información sobre la conexión base.
connectionSpec.id El ID de especificación de conexión asociado a Generic REST API. Este ID fijo es: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62.
auth.specName El tipo de autenticación que utiliza para conectar el origen a Platform.
auth.params.host La URL raíz que se usa para conectar con su Generic REST API fuente.
auth.params.username El nombre de usuario que corresponde a su Generic REST API fuente. Esto es necesario para la autenticación básica.
auth.params.password La contraseña que corresponde a su Generic REST API fuente. Esto es necesario para la autenticación básica.

Respuesta

Una respuesta correcta devuelve la conexión base recién creada, incluido su identificador de conexión único (id). Este ID es necesario para explorar la estructura de archivos y el contenido de la fuente en el siguiente paso.

{
    "id": "9601747c-6874-4c02-bb00-5732a8c43086",
    "etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}

Pasos siguientes

Al seguir este tutorial, ha creado un Generic REST API conexión base utilizando Flow Service API. Puede utilizar este ID de conexión base en los siguientes tutoriales:

En esta página