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

Última actualización: 16 de julio de 2024
  • Temas:

Creado para:

  • Desarrollador

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

Este tutorial lo guiará para crear una conexión base para Square mediante la Flow Service API.

Introducción

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

  • Fuentes: 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: 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.

Las secciones siguientes proporcionan información adicional que necesitará conocer para conectarse correctamente a Square mediante la API Flow Service.

Recopilar credenciales necesarias

Para que Flow Service se conecte con Square, debe proporcionar valores para las siguientes propiedades de conexión:

CredencialDescripción
hostDirección URL de la instancia Square.
clientIdIdentificador de cliente asociado con su cuenta de Square.
clientSecretEl secreto de cliente asociado con su cuenta de Square.
accessTokenEl token de acceso se utiliza para autenticar su cuenta de Square con la autenticación OAuth 2.0. El token de acceso se puede obtener de Square.
refreshTokenEl token de actualización se utiliza para generar nuevos tokens de acceso una vez que caduca el token de acceso actual. El token de actualización se puede obtener de Square.
connectionSpec.idLa especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. El id. de especificación de conexión para Square es: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5

Para obtener más información sobre estas credenciales y cómo obtenerlas, consulte la Square documentación sobre OAuth.

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.

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 las credenciales de autenticación Square como parte de los parámetros de solicitud.

Formato de API

POST /connections

Solicitud

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

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": "Square Base Connection",
        "description": "Square Base Connection",
        "auth": {
        "specName": "OAuth2 Refresh Code",
        "params": {
            "host": "{HOST}",
            "clientId": "{CLIENT_ID}",
            "clientSecret": "{CLIENT_SECRET}"
            "accessToken": "{ACCESS_TOKEN}"
            "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "2acf109f-9b66-4d5e-bc18-ebb2adcff8d5",
            "version": "1.0"
        }
    }'
PropiedadDescripción
auth.params.hostDirección URL de la instancia Square.
auth.params.clientIdIdentificador de cliente asociado con su cuenta de Square.
auth.params.clientSecretEl secreto de cliente asociado con su cuenta de Square.
auth.params.accessTokenEl token de acceso se utiliza para autenticar su cuenta de Square con la autenticación OAuth 2.0. El token de acceso se puede obtener de Square.
auth.params.refreshTokenEl token de actualización se utiliza para generar nuevos tokens de acceso una vez que caduca el token de acceso actual. El token de actualización se puede obtener de Square.
connectionSpec.idIdentificador de especificación de conexión Square: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5.

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": "24151d58-ffa7-4960-951d-58ffa7396097",
    "etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""
}