Kopiera data från Square med Hjälp av Azure Data Factory eller Synapse Analytics (förhandsversion)

GÄLLER FÖR: Azure Data Factory Azure Synapse Analytics

Dricks

Prova Data Factory i Microsoft Fabric, en allt-i-ett-analyslösning för företag. Microsoft Fabric omfattar allt från dataflytt till datavetenskap, realtidsanalys, business intelligence och rapportering. Lär dig hur du startar en ny utvärderingsversion kostnadsfritt!

Den här artikeln beskriver hur du använder kopieringsaktiviteten i en Azure Data Factory- eller Synapse Analytics-pipeline för att kopiera data från Square. Den bygger på översiktsartikeln för kopieringsaktivitet som visar en allmän översikt över kopieringsaktiviteten.

Viktigt!

Den här anslutningsappen är för närvarande i förhandsversion. Du kan prova och ge oss feedback. Om du vill skapa ett beroende på anslutningsappar som är i förhandsversion i din lösning kan du kontakta Azure-supporten.

Kommentar

Den här anslutningsappen stöder för närvarande inte sandbox-konton.

Funktioner som stöds

Den här Square-anslutningsappen stöds för följande funktioner:

Funktioner som stöds IR
aktiviteten Kopiera (källa/-) (1) (2)
Sökningsaktivitet (1) (2)

(1) Azure Integration Runtime (2) Lokalt installerad integrationskörning

En lista över datalager som stöds som källor/mottagare finns i tabellen Datalager som stöds.

Tjänsten tillhandahåller en inbyggd drivrutin för att aktivera anslutningen. Därför behöver du inte installera någon drivrutin manuellt med den här anslutningsappen.

Anslutningsappen stöder Windows-versionerna i den här artikeln.

Komma igång

Om du vill utföra aktiviteten Kopiera med en pipeline kan du använda något av följande verktyg eller SDK:er:

Skapa en länkad tjänst till Square med hjälp av användargränssnittet

Använd följande steg för att skapa en länkad tjänst till Square i användargränssnittet för Azure Portal.

  1. Bläddra till fliken Hantera i Din Azure Data Factory- eller Synapse-arbetsyta och välj Länkade tjänster och klicka sedan på Ny:

  2. Sök efter Fyrkant och välj square-anslutningsappen.

    Skärmbild av Square-anslutningsappen.

  3. Konfigurera tjänstinformationen, testa anslutningen och skapa den nya länkade tjänsten.

    Skärmbild av konfiguration av länkad tjänst för Square.

Konfigurationsinformation för anslutningsprogram

Följande avsnitt innehåller information om egenskaper som används för att definiera Data Factory-entiteter som är specifika för Square Connector.

Länkade tjänstegenskaper

Följande egenskaper stöds för kvadratlänkad tjänst:

Property Beskrivning Obligatoriskt
type Typegenskapen måste vara inställd på: Kvadrat Ja
connectionProperties En grupp med egenskaper som definierar hur du ansluter till Kvadrat. Ja
Under connectionProperties:
värd Url:en för Square-instansen. (d.v.s. mystore.mysquare.com) Ja
clientId Klient-ID:t som är associerat med ditt Square-program. Ja
clientSecret Klienthemligheten som är associerad med ditt Square-program. Markera det här fältet som en SecureString för att lagra det på ett säkert sätt eller referera till en hemlighet som lagras i Azure Key Vault. Ja
accessToken Åtkomsttoken som hämtas från Square. Ger begränsad åtkomst till ett Square-konto genom att be en autentiserad användare om explicita behörigheter. OAuth-åtkomsttoken upphör att gälla 30 dagar efter att de har utfärdats, men uppdateringstoken upphör inte att gälla. Åtkomsttoken kan uppdateras med uppdateringstoken.
Markera det här fältet som en SecureString för att lagra det på ett säkert sätt eller referera till en hemlighet som lagras i Azure Key Vault.
Ja
refreshToken Uppdateringstoken som hämtats från Kvadrat. Används för att hämta nya åtkomsttoken när den aktuella upphör att gälla.
Markera det här fältet som en SecureString för att lagra det säkertFactory, eller referera till en hemlighet som lagras i Azure Key Vault.
Nej
useEncryptedEndpoints Anger om datakällans slutpunkter krypteras med HTTPS. Standardvärdet är sant. Nej
useHostVerification Anger om värdnamnet i serverns certifikat ska behövas för att matcha serverns värdnamn vid anslutning via TLS. Standardvärdet är sant. Nej
usePeerVerification Anger om serverns identitet ska verifieras vid anslutning via TLS. Standardvärdet är sant. Nej

Square stöder två typer av åtkomsttoken: personlig och OAuth.

  • Personliga åtkomsttoken används för att få obegränsad Åtkomst till resurser i ditt eget Square-konto.

  • OAuth-åtkomsttoken används för att få autentiserad och begränsad Åtkomst-API till alla Square-konton. Använd dem när din app kommer åt resurser i andra Square-konton för kontoägares räkning. OAuth-åtkomsttoken kan också användas för att komma åt resurser i ditt eget Square-konto.

    Viktigt!

    För att utföra testanslutningen i den länkade tjänsten MERCHANT_PROFILE_READ krävs för att hämta en begränsad OAuth-åtkomsttoken. Behörigheter för åtkomst till andra tabeller finns i Referens för Square OAuth-behörigheter.

Autentisering via personlig åtkomsttoken behöver accessTokenbara , medan autentisering via OAuth kräver accessToken och refreshToken. Lär dig hur du hämtar åtkomsttoken härifrån.

Exempel:

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

Egenskaper för datauppsättning

En fullständig lista över avsnitt och egenskaper som är tillgängliga för att definiera datauppsättningar finns i artikeln datauppsättningar . Det här avsnittet innehåller en lista över egenskaper som stöds av Kvadratdatauppsättning.

Om du vill kopiera data från Square anger du datamängdens typegenskap till SquareObject. Följande egenskaper stöds:

Property Beskrivning Obligatoriskt
type Datamängdens typegenskap måste anges till: SquareObject Ja
tableName Tabellens namn. Nej (om "fråga" i aktivitetskällan har angetts)

Exempel

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

Kopiera egenskaper för aktivitet

En fullständig lista över avsnitt och egenskaper som är tillgängliga för att definiera aktiviteter finns i artikeln Pipelines . Det här avsnittet innehåller en lista över egenskaper som stöds av Kvadratkälla.

Kvadrat som källa

Om du vill kopiera data från Square anger du källtypen i kopieringsaktiviteten till SquareSource. Följande egenskaper stöds i avsnittet kopieringsaktivitetskälla:

Property Beskrivning Obligatoriskt
type Typegenskapen för kopieringsaktivitetskällan måste anges till: SquareSource Ja
query Använd den anpassade SQL-frågan för att läsa data. Exempel: "SELECT * FROM Business". Nej (om "tableName" i datauppsättningen har angetts)

Exempel:

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

Egenskaper för uppslagsaktivitet

Mer information om egenskaperna finns i Sökningsaktivitet.

En lista över datalager som stöds som källor och mottagare av kopieringsaktiviteten finns i datalager som stöds.