Compartilhar via

Copiar dados do Square usando o Azure Data Factory ou o Synapse Analytics (versão prévia)

  • Artigo

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Dica

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

Este artigo descreve como usar a atividade de cópia nos pipelines do Azure Data Factory ou do Azure Synapse Analytics para copiar dados de uma tabela do Square. Ele amplia o artigo Visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.

Importante

Atualmente, esse conector está em versão prévia. Você pode experimentá-lo e oferecer comentários. Se você quiser uma dependência de conectores em versão prévia em sua solução, entre em contato com suporte do Azure.

Observação

Atualmente, esse conector não dá suporte a contas de área restrita.

Funcionalidades com suporte

Este conector quadrado é compatível com os seguintes recursos:

Funcionalidades com suporte IR
Atividade de cópia (origem/-) ① ②
Atividade de pesquisa ① ②

① Runtime de integração do Azure ② Runtime de integração auto-hospedada

Para obter uma lista de armazenamentos de dados com suporte como origens e coletores, confira a tabela Armazenamentos de dados com suporte.

O serviço fornece um driver interno para habilitar a conectividade, portanto, não é necessário instalar manualmente qualquer driver usando esse conector.

O conector dá suporte às versões do Windows incluídas nesse artigo.

Introdução

Para executar a atividade de Cópia com um pipeline, será possível usar as ferramentas ou os SDKs abaixo:

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

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

  1. Navegue até a guia Gerenciar no workspace do Azure Data Factory ou do Synapse, selecione Serviços Vinculados e clique em Novo:

  2. Procure Square e selecione o conector do Square.

    Captura de tela do conector do Square.

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

    Captura de tela da configuração do serviço vinculado para o Square.

Detalhes da configuração do conector

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

Propriedades do serviço vinculado

As propriedades a seguir têm suporte para o serviço vinculado do Square:

Propriedade Descrição Obrigatório
type 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 A ID de cliente associada ao seu aplicativo Square. Sim
clientSecret O segredo do cliente associada ao seu aplicativo Square. Marque este campo como um SecureString para armazená-lo com segurança ou referencie um segredo armazenado no Azure Key Vault. Sim
accessToken O token de acesso obtido do Square. Concede acesso limitado a uma conta do Square por meio da solicitação de permissões explícitas a um usuário autenticado. Os tokens de acesso do 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 referencie um segredo armazenado no Azure Key Vault.		 Sim
refreshToken O token de atualização obtido do Square. Usado para obter novos tokens de acesso quando o atual expirar.
Marque esse campo como SecureString para armazená-lo com segurança no Factory ou referencie um segredo armazenado no Azure Key Vault.		 Não
useEncryptedEndpoints Especifica se os endpoints de fonte de dados são criptografados usando HTTPS. O valor padrão é true. Não
useHostVerification Especifica se o nome do host no certificado do servidor precisa ser igual ao nome do host do servidor nas conexões por TLS. O valor padrão é true. Não
usePeerVerification Especifica se a identidade do servidor deve ser verificada nas conexões por TLS. O valor padrão é true. Não

O Square é compatível com dois tipos de token de acesso: pessoal e OAuth.

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

  • Os tokens de acesso do OAuth são usados para obter acesso autenticado e com escopo da API do Connect a qualquer conta do Square. Use-os quando o aplicativo acessar recursos em outras contas do 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 do 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, confira Referência de Permissões do Square OAuth.

A autenticação por meio de token de acesso pessoal só precisa do 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>", 
                "clientSecret": {
                    "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 das seções e propriedades disponíveis para definir os conjuntos de dados, confira o artigo sobre conjuntos de dados. Esta seção fornece uma lista das propriedades com suporte pelo conjunto de dados do Square.

Para copiar dados do Square, defina a propriedade type do conjunto de dados como SquareObject. Há suporte para as seguintes propriedades:

Propriedade Descrição Obrigatório
type A propriedade type do conjunto de dados precisa ser definida como: SquareObject Sim
tableName Nome da tabela. Não (se "query" na fonte da atividade for especificada)

Exemplo

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

Propriedades da atividade de cópia

Para obter uma lista completa das seções e propriedades disponíveis para definir atividades, confia o artigo Pipelines. Esta seção fornece uma lista das propriedades com suporte pela origem do Square.

Square como fonte

Para copiar dados do Square, defina o tipo de origem na atividade de cópia como SquareSource. As propriedades a seguir têm suporte na seção source da atividade de cópia:

Propriedade Descrição Obrigatório
type A propriedade type da fonte da atividade de cópia deve ser definida como: SquareSource Sim
Consulta Utiliza a consulta SQL personalizada para ler os 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>"
            }
        }
    }
]

Pesquisar propriedades de atividade

Para saber detalhes sobre as propriedades, verifique Pesquisar atividade.

Conteúdo relacionado

Para obter uma lista de armazenamentos de dados com suporte como coletores e fontes da atividade de cópia, confira os armazenamentos de dados com suporte.