Udostępnij przez


Kopiowanie danych z square przy użyciu usługi Azure Data Factory lub Synapse Analytics

DOTYCZY: Azure Data Factory Azure Synapse Analytics

Napiwek

Wypróbuj usługę Data Factory w usłudze Microsoft Fabric — rozwiązanie analityczne typu all-in-one dla przedsiębiorstw. Usługa Microsoft Fabric obejmuje wszystko, od przenoszenia danych do nauki o danych, analizy w czasie rzeczywistym, analizy biznesowej i raportowania. Dowiedz się, jak bezpłatnie rozpocząć nową wersję próbną !

W tym artykule opisano sposób użycia działania kopiowania w potoku usługi Azure Data Factory lub Synapse Analytics w celu skopiowania danych z kwadratu. Jest on oparty na artykule omówienie działania kopiowania, który przedstawia ogólne omówienie działania kopiowania.

Ważne

Łącznik Square w wersji 1.0 jest na etapie usuwania. Zaleca się uaktualnienie łącznika Square z wersji 1.0 do 2.0.

Obsługiwane możliwości

Ten łącznik Square jest obsługiwany w następujących możliwościach:

Obsługiwane możliwości środowisko IR
działanie Kopiuj (źródło/-) (1) (2)
Działanie Lookup (1) (2)

(1) Środowisko Azure Integration Runtime (2) Self-hosted Integration Runtime

Aby uzyskać listę magazynów danych obsługiwanych jako źródła/ujścia, zobacz tabelę Obsługiwane magazyny danych.

Usługa udostępnia wbudowany sterownik umożliwiający łączność, dlatego nie trzeba ręcznie instalować żadnego sterownika przy użyciu tego łącznika.

Łącznik obsługuje wersje systemu Windows w tym artykule.

Wymagania wstępne

Jeśli magazyn danych znajduje się w sieci lokalnej, sieci wirtualnej Azure lub w środowisku Amazon Virtual Private Cloud, musisz skonfigurować własne środowisko uruchomieniowe integracji, aby się z nim połączyć.

Jeśli magazyn danych jest zarządzaną usługą danych w chmurze, możesz użyć środowiska Azure Integration Runtime. Jeśli dostęp jest ograniczony do adresów IP zatwierdzonych w regułach zapory, możesz dodać adresy IP środowiska Azure Integration Runtime do listy dozwolonych.

Możesz również użyć funkcji zarządzanego środowiska uruchomieniowego integracji sieci wirtualnej w usłudze Azure Data Factory, aby uzyskać dostęp do sieci lokalnej bez instalowania i konfigurowania własnego środowiska uruchomieniowego integracji.

Aby uzyskać więcej informacji na temat mechanizmów zabezpieczeń sieci i opcji obsługiwanych przez usługę Data Factory, zobacz Strategie dostępu do danych.

Uwaga

Wersja 2.0 jest obsługiwana w przypadku własnego środowiska Integration Runtime w wersji 5.56.0.0 lub nowszej.

Wprowadzenie

Aby wykonać działanie kopiowania za pomocą potoku, możesz użyć jednego z następujących narzędzi lub zestawów SDK:

Tworzenie połączonej usługi z platformą Square przy użyciu interfejsu użytkownika

Wykonaj poniższe kroki, aby utworzyć połączoną usługę z aplikacją Square w interfejsie użytkownika witryny Azure Portal.

  1. Przejdź do karty Zarządzanie w obszarze roboczym usługi Azure Data Factory lub Synapse i wybierz pozycję Połączone usługi, a następnie kliknij pozycję Nowy:

  2. Wyszukaj ciąg Square i wybierz łącznik Square.

    Zrzut ekranu przedstawiający łącznik Square.

  3. Skonfiguruj szczegóły usługi, przetestuj połączenie i utwórz nową połączoną usługę.

    Zrzut ekranu przedstawiający połączoną konfigurację usługi dla kwadratu.

Szczegóły konfiguracji łącznika

Poniższe sekcje zawierają szczegółowe informacje o właściwościach używanych do definiowania jednostek usługi Data Factory specyficznych dla łącznika Square.

Właściwości połączonej usługi

Łącznik Square obsługuje teraz wersję 2.0. Zapoznaj się z tą sekcją , aby uaktualnić wersję łącznika Square z wersji 1.0. Aby uzyskać informacje szczegółowe dotyczące nieruchomości, zobacz odpowiednie sekcje.

Wersja 2.0

Połączona usługa Square obsługuje następujące właściwości w przypadku zastosowania wersji 2.0:

Właściwości Opis Wymagania
typ Właściwość type musi być ustawiona na: Square Tak
wersja Wersja, którą określisz. Wartość to 2.0. Tak
gospodarz Adres URL wystąpienia Square. (tj. mystore.mysquare.com) Tak
clientId Identyfikator klienta skojarzony z aplikacją Square. Tak
clientSecret Wpis tajny klienta skojarzony z aplikacją Square. Oznacz to pole jako element SecureString w celu bezpiecznego przechowywania go lub odwołuj się do wpisu tajnego przechowywanego w usłudze Azure Key Vault. Tak
accessToken Token dostępu uzyskany z kwadratu. Udziela ograniczonego dostępu do konta Square, prosząc uwierzytelnionego użytkownika o jawne uprawnienia. Tokeny dostępu OAuth wygasają 30 dni po wystawieniu, ale tokeny odświeżania nie wygasają. Tokeny dostępu można odświeżać za pomocą tokenu odświeżania.
Oznacz to pole jako element SecureString w celu bezpiecznego przechowywania go lub odwołuj się do wpisu tajnego przechowywanego w usłudze Azure Key Vault. Aby uzyskać więcej informacji na temat typów tokenów dostępu, zobacz Access token types (Typy tokenów dostępu).
Tak
refreshToken Token odświeżania uzyskany z kwadratu. Służy do uzyskiwania nowych tokenów dostępu po wygaśnięciu bieżącego tokenu.
Oznacz to pole jako element SecureString, aby przechowywać je bezpiecznieFactory lub odwoływać się do wpisu tajnego przechowywanego w usłudze Azure Key Vault.
Nie.
connectVia Środowisko Integration Runtime używane do połączenia z repozytorium danych. Jeśli nie zostanie określony, używa domyślnego środowiska Azure Integration Runtime. Możesz użyć własnego środowiska Integration Runtime, a jego wersja powinna mieć wartość 5.56.0.0 lub nowszą. Nie.

Przykład:

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

Wersja 1.0

Połączona usługa Square obsługuje następujące właściwości w przypadku zastosowania wersji 1.0:

Właściwości Opis Wymagania
typ Właściwość type musi być ustawiona na: Square Tak
connectionProperties Grupa właściwości definiujących sposób nawiązywania połączenia z kwadratem. Tak
W obszarze connectionProperties:
gospodarz Adres URL wystąpienia Square. (tj. mystore.mysquare.com) Tak
clientId Identyfikator klienta skojarzony z aplikacją Square. Tak
clientSecret Wpis tajny klienta skojarzony z aplikacją Square. Oznacz to pole jako element SecureString w celu bezpiecznego przechowywania go lub odwołuj się do wpisu tajnego przechowywanego w usłudze Azure Key Vault. Tak
accessToken Token dostępu uzyskany z kwadratu. Udziela ograniczonego dostępu do konta Square, prosząc uwierzytelnionego użytkownika o jawne uprawnienia. Tokeny dostępu OAuth wygasają 30 dni po wystawieniu, ale tokeny odświeżania nie wygasają. Tokeny dostępu można odświeżać za pomocą tokenu odświeżania.
Oznacz to pole jako element SecureString w celu bezpiecznego przechowywania go lub odwołuj się do wpisu tajnego przechowywanego w usłudze Azure Key Vault. Aby uzyskać więcej informacji na temat typów tokenów dostępu, zobacz Access token types (Typy tokenów dostępu).
Tak
refreshToken Token odświeżania uzyskany z kwadratu. Służy do uzyskiwania nowych tokenów dostępu po wygaśnięciu bieżącego tokenu.
Oznacz to pole jako element SecureString, aby przechowywać je bezpiecznieFactory lub odwoływać się do wpisu tajnego przechowywanego w usłudze Azure Key Vault.
Nie.
useEncryptedEndpoints Określa, czy punkty końcowe źródła danych są szyfrowane przy użyciu protokołu HTTPS. Wartość domyślna to true. Nie.
useHostVerification Określa, czy nazwa hosta w certyfikacie serwera ma być zgodna z nazwą hosta serwera podczas nawiązywania połączenia za pośrednictwem protokołu TLS. Wartość domyślna to true. Nie.
usePeerVerification Określa, czy należy zweryfikować tożsamość serwera podczas nawiązywania połączenia za pośrednictwem protokołu TLS. Wartość domyślna to true. Nie.
connectVia Środowisko Integration Runtime używane do połączenia z repozytorium danych. Jeśli nie zostanie określony, używa domyślnego środowiska Azure Integration Runtime. Nie.

Przykład:

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

Typy tokenów dostępu

Kwadrat obsługuje dwa typy tokenu dostępu: osobiste i OAuth.

  • Osobiste tokeny dostępu są używane do uzyskiwania nieograniczonego dostępu interfejsu API Connect do zasobów na własnym koncie Square.

  • Tokeny dostępu OAuth są używane do uzyskiwania uwierzytelnionego i ograniczonego dostępu interfejsu API connect do dowolnego konta Square. Użyj ich, gdy aplikacja uzyskuje dostęp do zasobów na innych kontach Square w imieniu właścicieli kont. Tokeny dostępu OAuth mogą być również używane do uzyskiwania dostępu do zasobów na własnym koncie Square.

    Ważne

    Aby wykonać testowe połączenie w połączonej usłudze, MERCHANT_PROFILE_READ wymagane jest uzyskanie tokenu dostępu OAuth w zakresie. Aby uzyskać uprawnienia dostępu do innych tabel, zobacz Square OAuth Permissions Reference (Dokumentacja uprawnień uwierzytelniania OAuth kwadratu).

Uwierzytelnianie za pośrednictwem osobistego tokenu dostępu wymaga accessTokentylko wartości , a uwierzytelnianie za pośrednictwem protokołu OAuth wymaga accessToken i refreshToken. Dowiedz się, jak pobrać token dostępu z tego miejsca.

Właściwości zestawu danych

Pełna lista sekcji i właściwości dostępnych do definiowania zestawów danych znajduje się w artykule dotyczącym zestawów danych. Ta sekcja zawiera listę właściwości obsługiwanych przez zestaw danych Square.

Aby skopiować dane z kwadratu, ustaw właściwość type zestawu danych na SquareObject. Obsługiwane są następujące właściwości:

Właściwości Opis Wymagania
typ Właściwość type zestawu danych musi być ustawiona na: SquareObject Tak
tableName Nazwa tabeli. Tak dla wersji 2.0.
Nie dla wersji 1.0 (jeśli określono "zapytanie" w źródle działania)

Przykład

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

Właściwości działania kopiowania

Aby uzyskać pełną listę sekcji i właściwości dostępnych do definiowania działań, zobacz artykuł Pipelines (Potoki ). Ta sekcja zawiera listę właściwości obsługiwanych przez źródło Square.

Kwadrat jako źródło

Aby skopiować dane z kwadratu, ustaw typ źródła w działaniu kopiowania na SquareSource. Następujące właściwości są obsługiwane w sekcji źródło działania kopiowania:

Właściwości Opis Wymagania
typ Właściwość type źródła działania kopiowania musi być ustawiona na: SquareSource Tak
kwerenda Użyj niestandardowego zapytania SQL, aby odczytać dane. Na przykład: "SELECT * FROM Business". Nie (jeśli określono "tableName" w zestawie danych)

Uwaga

query nie jest obsługiwany w wersji 2.0.

Przykład:

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

Mapowanie typu danych dla kwadratu

Podczas kopiowania danych z kwadratu następujące mapowania są stosowane z typów danych Square do wewnętrznych typów danych używanych przez usługę. Aby dowiedzieć się, jak działanie kopiowania mapuje schemat źródłowy i typ danych na docelowy, zobacz Mapowanie schematu i typu danych.

Typ danych kwadratowych Typ danych usługi tymczasowej (wersja 2.0) Typ danych usługi tymczasowej (wersja 1.0)
Sznurek Sznurek Sznurek
Integer Int32 Int32
Long Int64 Int64
logiczny logiczny logiczny
Date Sznurek Niewspierane.
Sygnatura czasowa Sznurek Niewspierane.
Znacznik czasu z przesunięciem Sznurek Niewspierane.
Czas trwania (pełny) Sznurek Sznurek
Czas trwania (tylko czas) Sznurek Sznurek
Pieniądze Int64 Int64

Właściwości działania wyszukiwania

Aby dowiedzieć się więcej o właściwościach, sprawdź działanie Wyszukiwania.

Cykl życia i uaktualnianie łącznika kwadratu

W poniższej tabeli przedstawiono etap wydania i dzienniki zmian dla różnych wersji łącznika Square:

wersja Etap wydania Dziennik zmian
Wersja 1.0 Removed Nie dotyczy.
Wersja 2.0 Ogólna dostępność • Wersja własnego środowiska Integration Runtime powinna mieć wartość 5.56.0.0 lub nowszą.

• Data, znacznik czasu i znacznik czasu z przesunięciem są odczytywane jako typ danych Ciąg.

useEncryptedEndpoints, useHostVerification, usePeerVerification nie są obsługiwane w połączonej usłudze.

query nie jest obsługiwana.

Uaktualnianie łącznika Square z wersji 1.0 do wersji 2.0

  1. Na stronie Edytowanie połączonej usługi wybierz wersję 2.0. Aby uzyskać więcej informacji, zobacz właściwości połączonej usługi w wersji 2.0.

  2. Mapowanie typu danych dla połączonej usługi Square w wersji 2.0 różni się od tego dla wersji 1.0. Aby dowiedzieć się więcej na temat najnowszego mapowania typów danych, zobacz Mapowanie typów danych dla kwadratu.

  3. Zastosuj własne środowisko Integration Runtime w wersji 5.56.0.0 lub nowszej.

  4. query program jest obsługiwany tylko w wersji 1.0. Należy użyć elementu tableName zamiast query w wersji 2.0.

Aby uzyskać listę magazynów danych obsługiwanych jako źródła i ujścia działania kopiowania, zobacz obsługiwane magazyny danych.