Copiar dados do Square usando Azure Data Factory ou Synapse Analytics

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Este artigo descreve como usar a Atividade de Cópia em um pipeline do Azure Data Factory ou do Synapse Analytics para copiar dados do Square. Ele se baseia no artigo de visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.

Capacidades suportadas

Este conector quadrado é suportado para as seguintes capacidades:

(1) Tempo de execução de integração do Azure (2) Tempo de execução de integração auto-hospedado

Para obter uma lista de armazenamentos de dados suportados como fontes/coletores, consulte a tabela Armazenamentos de dados suportados.

O serviço fornece um driver interno para habilitar a conectividade, portanto, você não precisa instalar manualmente nenhum driver usando esse conector.

O conector suporta as versões do Windows neste artigo.

Pré-requisitos

Se o seu armazenamento de dados estiver localizado dentro de uma rede no local, uma rede virtual do Azure ou uma Amazon Virtual Private Cloud, precisa configurar um ambiente de execução de integração auto-hospedado para se conectar a ele.

Se o seu armazenamento de dados for um serviço de dados de nuvem gerenciado, você poderá usar o Tempo de Execução de Integração do Azure. Se o acesso for restrito a IPs aprovados nas regras de firewall, você poderá adicionar IPs do Azure Integration Runtime à lista de permissões.

Você também pode usar a funcionalidade de runtime de integração de rede virtual gerida na Azure Data Factory para aceder à rede local sem necessidade de instalar e configurar um runtime de integração auto-hospedado.

Para obter mais informações sobre os mecanismos de segurança de rede e as opções suportadas pelo Data Factory, consulte Estratégias de acesso a dados.

Introdução

Para executar a atividade de cópia com um pipeline, você pode usar uma das seguintes ferramentas ou SDKs:

• Ferramenta Copiar dados
• portal do Azure
• SDK do .NET
• Python SDK
• Azure PowerShell
• API REST
• Modelo Azure Resource Manager

Criar um serviço vinculado ao Square usando a interface do usuário

Use as etapas a seguir para criar um serviço vinculado ao Square na interface do usuário do portal do Azure.

1. Navegue até a guia Gerenciar em seu espaço de trabalho do Azure Data Factory ou Synapse e selecione Serviços Vinculados e clique em Novo:

   • Fábrica de Dados do Azure
   • Sinapse do Azure

   

2. Procure por Square e selecione o conector Square.

   

3. Configure os detalhes do serviço, teste a conexão e crie o novo serviço vinculado.

   

Detalhes de configuração do conector

As seções a seguir fornecem detalhes sobre as propriedades usadas para definir entidades do Data Factory específicas para o conector Square.

Propriedades do serviço vinculado

O conector Square agora suporta a versão 2.0. Consulte esta seção para atualizar a versão do conector Square da versão 1.0. Para obter os detalhes da propriedade, consulte as seções correspondentes.

• Versão 2.0
• Versão 1.0

Versão 2.0

O serviço ligado Square suporta as seguintes propriedades quando aplicada a versão 2.0:

Exemplo:

{
    "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"
        }
    }
}

Versão 1.0

O serviço vinculado Square suporta as seguintes propriedades quando aplicar a versão 1.0:

Exemplo:

{
    "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 acesso

O Square suporta dois tipos de token de acesso: pessoal e OAuth.

• Os tokens de acesso pessoal são usados para obter acesso ilimitado à API Connect aos recursos em sua própria conta Square.

• Os tokens de acesso OAuth são usados para obter acesso autenticado e com escopo à API Connect para qualquer conta Square. Use-os quando seu aplicativo acessar recursos em outras contas Square em nome dos proprietários da conta. Os tokens de acesso OAuth também podem ser usados para acessar recursos em sua própria conta Square.

  Importante

  Para executar a conexão de teste no serviço vinculado, MERCHANT_PROFILE_READ é necessário obter um token de acesso OAuth com escopo. Para obter permissões para acessar outras tabelas, consulte Referência de permissões OAuth quadradas.

A autenticação via token de acesso pessoal só precisa de , enquanto a accessTokenautenticação via OAuth requer accessToken e refreshToken. Saiba como recuperar o token de acesso aqui.

Propriedades do conjunto de dados

Para obter uma lista completa de seções e propriedades disponíveis para definir conjuntos de dados, consulte o artigo sobre conjuntos de dados. Esta seção fornece uma lista de propriedades suportadas pelo conjunto de dados Square.

Para copiar dados de Square, defina a propriedade type do conjunto de dados como SquareObject. As seguintes propriedades são suportadas:

Exemplo

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

Propriedades da atividade Copy

Para obter uma lista completa de seções e propriedades disponíveis para definir atividades, consulte o artigo Pipelines . Esta seção fornece uma lista de propriedades suportadas pela fonte Square.

Quadrado como fonte

Para copiar dados do Square, defina o tipo de origem na atividade de cópia como SquareSource. As seguintes propriedades são suportadas na seção de origem da atividade de cópia:

Exemplo:

"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>"
            }
        }
    }
]

Mapeamento de tipo de dados para Square

Quando você copia dados do Square, os mapeamentos a seguir se aplicam dos tipos de dados do Square aos tipos de dados internos usados pelo serviço. Para saber como a atividade de cópia mapeia o esquema de origem e o tipo de dados para o destino, consulte Mapeamentos de esquema e tipo de dados.

Propriedades da atividade de pesquisa

Para saber detalhes sobre as propriedades, verifique Atividade de pesquisa.

Ciclo de vida e atualização do conector quadrado

A tabela a seguir mostra o estágio de liberação e os logs de alteração para diferentes versões do conector quadrado:

Atualize o conector Square da versão 1.0 para a versão 2.0

1. Na página Editar serviço vinculado , selecione 2.0 para a versão. Para obter mais informações, consulte Propriedades do serviço vinculado versão 2.0.

2. O mapeamento de tipo de dados para o serviço vinculado Square versão 2.0 é diferente daquele para a versão 1.0. Para saber o mapeamento de tipo de dados mais recente, consulte Mapeamento de tipo de dados para Square.

3. Aplique um tempo de execução de integração auto-hospedado com a versão 5.56.0.0 ou superior.

4. query só é suportado na versão 1.0. Você deve usar o tableName em vez de query na versão 2.0.

Conteúdos relacionados

Para obter uma lista de armazenamentos de dados suportados como fontes e coletores pela atividade de cópia, consulte Armazenamentos de dados suportados.