Compartir a través de


Copia de datos de Square con Azure Data Factory o Synapse Analytics (versión preliminar)

SE APLICA A: Azure Data Factory Azure Synapse Analytics

Sugerencia

Pruebe Data Factory en Microsoft Fabric, una solución de análisis integral para empresas. Microsoft Fabric abarca todo, desde el movimiento de datos hasta la ciencia de datos, el análisis en tiempo real, la inteligencia empresarial y la creación de informes. Obtenga información sobre cómo iniciar una nueva evaluación gratuita.

En este artículo se explica cómo usar la actividad de copia en una canalización de Azure Data Factory o Synapse Analytics para copiar datos de Square. El documento se basa en el artículo de introducción a la actividad de copia que describe información general de la actividad de copia.

Importante

Este conector está actualmente en versión preliminar. Puede probarlo y enviarnos sus comentarios. Si desea depender de los conectores de versión preliminar en la solución, póngase en contacto con el soporte técnico de Azure.

Importante

El conector Square versión 2.0 (versión preliminar) proporciona compatibilidad nativa mejorada con Square. Si está usando Square Connector versión 1.0 en su solución, actualice el Square Connector antes del 15 de octubre de 2025. Consulte esta sección para obtener más información sobre la diferencia entre la versión 2.0 (versión preliminar) y la versión 1.0.

Funcionalidades admitidas

El conector Square es compatible con las siguientes funcionalidades:

Funcionalidades admitidas IR
Actividad de copia (origen/-) 1 2
Actividad de búsqueda 1 2

① Azure Integration Runtime ② Entorno de ejecución de integración autohospedado

Para obtener una lista de los almacenes de datos que se admiten como orígenes y receptores, consulte la tabla de almacenes de datos admitidos.

El servicio proporciona un controlador integrado para habilitar la conectividad. Por lo tanto, no es necesario instalar manualmente ningún controlador mediante este conector.

El conector admite las versiones de Windows de este artículo.

Prerrequisitos

Si el almacén de datos se encuentra en una red local, una red virtual de Azure o una nube privada virtual de Amazon, debe configurar un entorno de ejecución de integración autohospedado para conectarse a él.

Si el almacén de datos es un servicio de datos en la nube administrado, puede usar Azure Integration Runtime. Si el acceso está restringido a las direcciones IP que están aprobadas en las reglas de firewall, puede agregar direcciones IP de Azure Integration Runtime a la lista de permitidos.

También puede usar la característica del entorno de ejecución de integración de red virtual administrada de Azure Data Factory para acceder a la red local sin instalar ni configurar un entorno de ejecución de integración autohospedado.

Consulte Estrategias de acceso a datos para más información sobre los mecanismos de seguridad de red y las opciones que admite Data Factory.

Nota:

La versión 2.0 (versión preliminar) se admite con la versión 5.56.0.0 o posterior del entorno de ejecución de integración autohospedado.

Introducción

Para realizar la actividad de copia con una canalización, puede usar una de las siguientes herramientas o SDK:

Creación de un servicio vinculado a Square mediante la interfaz de usuario

Siga estos pasos para crear un servicio vinculado a Square en la interfaz de usuario de Azure Portal.

  1. Vaya a la pestaña "Administrar" de su área de trabajo de Azure Data Factory o Synapse y seleccione "Servicios vinculados"; a continuación, haga clic en "Nuevo":

  2. Busque Square y seleccione el conector de Square.

    Captura de pantalla del conector de Square.

  3. Configure los detalles del servicio, pruebe la conexión y cree el servicio vinculado.

    Captura de pantalla de la configuración del servicio vinculado en Square.

Detalles de configuración del conector

En las secciones siguientes se proporcionan detalles sobre las propiedades que se usan para definir entidades de Data Factory específicas del conector de Square.

Propiedades del servicio vinculado

El conector square ahora admite la versión 2.0 (versión preliminar). Consulte esta sección para actualizar la versión del conector Square a partir de la versión 1.0. Para obtener los detalles de la propiedad, consulte las secciones correspondientes.

Versión 2.0 (versión preliminar)

El servicio vinculado Square admite las siguientes propiedades cuando se aplica la versión 2.0 (vista previa):

Propiedad Descripción Obligatorio
type La propiedad type debe establecerse en: Square
version Versión que especifique. El valor es 2.0.
host Dirección URL de la instancia de Square. (es decir, mystore.mysquare.com)
clientId Id. de cliente asociado a la aplicación Square.
clientSecret Secreto de cliente asociado a la aplicación Square. Marque este campo como SecureString para almacenarlo de forma segura, o bien haga referencia a un secreto almacenado en Azure Key Vault.
accessToken Token de acceso obtenido de Square. Concede acceso limitado a una cuenta de Square solicitando permisos explícitos a un usuario autenticado. Los tokens de acceso de OAuth expiran 30 días después de emitirse, pero los tokens de actualización no expiran. Los tokens de acceso se pueden actualizar mediante un token de actualización.
Marque este campo como SecureString para almacenarlo de forma segura, o bien haga referencia a un secreto almacenado en Azure Key Vault. Para obtener más información sobre los tipos de token de acceso, consulte Tipos de token de acceso.
refreshToken Token de actualización obtenido de Square. Se usa para obtener nuevos tokens de acceso cuando expira el actual.
Marque este campo como SecureString para almacenarlo de forma segura en Data Factory, o bien para hacer referencia a un secreto almacenado en Azure Key Vault.
No
connectVia El entorno Integration Runtime que se usará para conectarse al almacén de datos. Si no se especifica, se usará el Azure Integration Runtime predeterminado. Puede usar el entorno de ejecución de integración autohospedado y su versión debe ser 5.56.0.0 o superior. No

Ejemplo:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "version": "2.0",
        "typeProperties": {
            "host": "<e.g. mystore.mysquare.com>", 
            "clientId": "<client ID>", 
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            }, 
            "accessToken": {
                "type": "SecureString",
                "value": "<access token>"
            }, 
            "refreshToken": {
                "type": "SecureString",
                "value": "<refresh token>"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Versión 1.0

El servicio vinculado Square admite las siguientes propiedades al aplicar la versión 1.0.

Propiedad Descripción Obligatorio
type La propiedad type debe establecerse en: Square
connectionProperties Grupo de propiedades que define cómo conectarse a Square.
En connectionProperties:
host Dirección URL de la instancia de Square. (es decir, mystore.mysquare.com)
clientId Id. de cliente asociado a la aplicación Square.
clientSecret Secreto de cliente asociado a la aplicación Square. Marque este campo como SecureString para almacenarlo de forma segura, o bien haga referencia a un secreto almacenado en Azure Key Vault.
accessToken Token de acceso obtenido de Square. Concede acceso limitado a una cuenta de Square solicitando permisos explícitos a un usuario autenticado. Los tokens de acceso de OAuth expiran 30 días después de emitirse, pero los tokens de actualización no expiran. Los tokens de acceso se pueden actualizar mediante un token de actualización.
Marque este campo como SecureString para almacenarlo de forma segura, o bien haga referencia a un secreto almacenado en Azure Key Vault. Para obtener más información sobre los tipos de token de acceso, consulte Tipos de token de acceso.
refreshToken Token de actualización obtenido de Square. Se usa para obtener nuevos tokens de acceso cuando expira el actual.
Marque este campo como SecureString para almacenarlo de forma segura en Data Factory, o bien para hacer referencia a un secreto almacenado en Azure Key Vault.
No
useEncryptedEndpoints Especifica si los puntos de conexión de origen de datos se cifran mediante HTTPS. El valor predeterminado es true. No
useHostVerification Especifica si se requiere que el nombre de host del certificado del servidor coincida con el nombre de host del servidor al conectarse a través de TLS. El valor predeterminado es true. No
usePeerVerification Especifica si se debe verificar la identidad del servidor al conectarse a través de TLS. El valor predeterminado es true. No
connectVia El entorno Integration Runtime que se usará para conectarse al almacén de datos. Si no se especifica, se usará el Azure Integration Runtime predeterminado. No

Ejemplo:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "typeProperties": {
            "connectionProperties": {
                "host": "<e.g. mystore.mysquare.com>", 
                "clientId": "<client ID>", 
                "clientSecret": {
                    "type": "SecureString",
                    "value": "<clientSecret>"
                }, 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true 
            }
        }
    }
}

Tipos de token de acceso

Square admite dos tipos de tokens de acceso: personal y OAuth.

  • Los tokens de acceso personal se usan para que Connect API tenga acceso ilimitado a los recursos de su propia cuenta de Square.

  • Los tokens de acceso de OAuth se usan para que Connect API tenga acceso autenticado y por ámbito a cualquier cuenta de Square. Úselos cuando la aplicación acceda a recursos de otras cuentas de Square en nombre de los propietarios de la cuenta. Los tokens de acceso de OAuth también se pueden usar para acceder a recursos de su propia cuenta de Square.

    Importante

    Para realizar la Prueba de conexión en el servicio vinculado, es necesario que MERCHANT_PROFILE_READ obtenga un token de acceso de OAuth con ámbito. Para obtener permisos para acceder a otras tablas, consulte Referencia de permisos de Square OAuth.

La autenticación mediante el token de acceso personal solo necesita accessToken, mientras que la autenticación mediante OAuth necesita accessToken y refreshToken. Obtenga información sobre cómo recuperar el token de acceso aquí.

Propiedades del conjunto de datos

Si desea ver una lista completa de las secciones y propiedades disponibles para definir conjuntos de datos, consulte el artículo sobre conjuntos de datos. En esta sección se proporciona una lista de las propiedades compatibles con el conjunto de datos de Square.

Para copiar datos de Square, establezca la propiedad type del conjunto de datos en SquareObject. Se admiten las siguientes propiedades:

Propiedad Descripción Obligatorio
type La propiedad type del conjunto de datos debe establecerse en: SquareObject
tableName Nombre de la tabla. Sí para la versión 2.0 (versión preliminar).
No para la versión 1.0 (si se especifica "query" en el origen de actividad)

Ejemplo

{
    "name": "SquareDataset",
    "properties": {
        "type": "SquareObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Square linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Propiedades de la actividad de copia

Si desea ver una lista completa de las secciones y propiedades disponibles para definir actividades, consulte el artículo sobre canalizaciones. En esta sección se proporciona una lista de las propiedades compatibles con el origen de Square.

Square como origen

Si va a copiar datos de Square, establezca el tipo de origen de la actividad de copia en SquareSource. Se admiten las siguientes propiedades en la sección source de la actividad de copia:

Propiedad Descripción Obligatorio
type La propiedad type del origen de la actividad de copia debe establecerse en: SquareSource
Query Use la consulta SQL personalizada para leer los datos. Por ejemplo: "SELECT * FROM Business". No (si se especifica "tableName" en el conjunto de datos)

Nota:

query no se admite en la versión 2.0 (versión preliminar).

Ejemplo:

"activities":[
    {
        "name": "CopyFromSquare",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Square input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SquareSource",
                "query": "SELECT * FROM Business"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Asignación de tipos de datos para Square

Al copiar datos de Square, se aplican las siguientes asignaciones de los tipos de datos de Square a los tipos de datos internos utilizados por el servicio. Para más información acerca de la forma en que la actividad de copia asigna el tipo de datos y el esquema de origen al receptor, consulte el artículo sobre asignaciones de tipos de datos y esquema.

Tipo de datos Square Tipo de datos de servicio provisional (para la versión 2.0 (versión preliminar)) Tipo de datos de servicio provisional (para la versión 1.0)
String String String
Integer Int32 Int32
Long Int64 Int64
Boolean Boolean Boolean
Fecha String No está soportado.
Marca de tiempo String No está soportado.
Marca de tiempo con zona horaria de desplazamiento String No está soportado.
Duración (completa) String String
Duración (solo tiempo) String String
Dinero Int64 Int64

Propiedades de la actividad de búsqueda

Para obtener información detallada sobre las propiedades, consulte Actividad de búsqueda.

Ciclo de vida y actualización del conector cuadrado

En la tabla siguiente se muestran la fase de lanzamiento y los registros de cambios para diferentes versiones del conector Square:

Versión Fase de versión Registro de cambios
Versión 1.0 Finalización del soporte anunciada /
Versión 2.0 Public Preview • La versión del entorno de ejecución de integración autohospedado debe ser 5.56.0.0 o superior.

• Fecha, marca de tiempo y marca de tiempo con zona horaria de desplazamiento se leen como tipo de datos String.

useEncryptedEndpoints, useHostVerification, usePeerVerification no se admiten en el servicio vinculado.

query no está permitida.

Actualización del conector square de la versión 1.0 a la versión 2.0 (versión preliminar)

  1. En la página Editar servicio vinculado, seleccione 2.0 (versión preliminar) para la versión. Para más información, consulte propiedades del servicio vinculado versión 2.0 (versión preliminar).

  2. La asignación de tipos de datos para la versión 2.0 del servicio vinculado Square es diferente de la de la versión 1.0. Para obtener información sobre la asignación de tipos de datos más reciente, consulte Asignación de tipos de datos para Square.

  3. Aplique un entorno de ejecución de integración autohospedado con la versión 5.56.0.0 o posterior.

  4. query solo se admite en la versión 1.0. Debe usar tableName en lugar de query en la versión 2.0 (versión preliminar).

Para obtener una lista de los almacenes de datos que admite la actividad de copia como orígenes y receptores, consulte Almacenes de datos compatibles.