Copiar dados da Square usando o Azure Data Factory ou o Synapse Analytics (Visualização)

  • Artigo

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Gorjeta

Experimente o Data Factory no Microsoft Fabric, uma solução de análise tudo-em-um para empresas. O Microsoft Fabric abrange tudo, desde a movimentação de dados até ciência de dados, análises em tempo real, business intelligence e relatórios. Saiba como iniciar uma nova avaliação gratuitamente!

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.

Importante

Este conector está atualmente em pré-visualização. Você pode experimentá-lo e nos dar feedback. Se quiser realizar uma dependência em conectores de pré-visualização na sua solução, contacte o Suporte do Azure.

Nota

Atualmente, esse conector não suporta contas de área restrita.

Capacidades suportadas

Este conector quadrado é suportado para as seguintes capacidades:

Capacidades suportadas IR
Atividade de cópia (fonte/-) ① ②
Atividade de Pesquisa ① ②

(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.

Introdução

Para executar a atividade Copiar com um pipeline, você pode usar uma das seguintes ferramentas ou SDKs:

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:

  2. Procure por Square e selecione o conector Square.

    Screenshot of the Square connector.

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

    Screenshot of linked service configuration for Square.

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

As seguintes propriedades são suportadas para o serviço vinculado Square:

Propriedade Descrição Necessário
tipo A propriedade type deve ser definida como: Square Sim
connectionProperties Um grupo de propriedades que define como se conectar ao Square. Sim
Em connectionProperties:
host A URL da instância Square. (ou seja, mystore.mysquare.com) Sim
clientId O ID do cliente associado ao seu aplicativo Square. Sim
clientSecret O segredo do cliente associado à sua aplicação Square. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim
accessToken O token de acesso obtido da Square. Concede acesso limitado a uma conta Square solicitando permissões explícitas a um usuário autenticado. Os tokens de acesso OAuth expiram 30 dias após a emissão, mas os tokens de atualização não expiram. Os tokens de acesso podem ser atualizados pelo token de atualização.
Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure.		 Sim
refreshToken O token de atualização obtido da Square. Usado para obter novos tokens de acesso quando o atual expirar.
Marque este campo como um SecureString para armazená-lo securelyFactory ou faça referência a um segredo armazenado no Cofre de Chaves do Azure.		 Não
useEncryptedEndpoints Especifica se os pontos de extremidade da fonte de dados são criptografados usando HTTPS. O valor predefinido é true. Não
useHostVerification Especifica se o nome do host no certificado do servidor deve corresponder ao nome do host do servidor ao se conectar por TLS. O valor predefinido é true. Não
usePeerVerification Especifica se a identidade do servidor deve ser verificada ao se conectar por TLS. O valor predefinido é true. Não

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 accessToken, enquanto a autenticação via OAuth requer accessToken e refreshToken. Saiba como recuperar o token de acesso aqui.

Exemplo:

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

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:

Propriedade Descrição Necessário
tipo A propriedade type do conjunto de dados deve ser definida como: SquareObject Sim
tableName Nome da tabela. Não (se "consulta" na fonte da atividade for especificado)

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:

Propriedade Descrição Necessário
tipo A propriedade type da fonte de atividade de cópia deve ser definida como: SquareSource Sim
query Use a consulta SQL personalizada para ler dados. Por exemplo: "SELECT * FROM Business". Não (se "tableName" no conjunto de dados for especificado)

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

Propriedades da atividade de pesquisa

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

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.