Menyalin data dari Square menggunakan Azure Data Factory atau Synapse Analytics

Azure Data Factory Azure Synapse Analytics

Petunjuk

Data Factory di Microsoft Fabric adalah generasi Azure Data Factory berikutnya, dengan arsitektur yang lebih sederhana, AI bawaan, dan fitur baru. Jika Anda baru menggunakan integrasi data, mulailah dengan Fabric Data Factory. Beban kerja ADF yang ada dapat ditingkatkan ke Fabric untuk mengakses kemampuan baru di seluruh ilmu data, analitik real time, dan pelaporan.

Artikel ini menguraikan cara menggunakan Aktivitas Salin di alur Azure Data Factory atau Synapse Analytics untuk menyalin data dari Square. Artikel tersebut dibuat berdasarkan artikel gambaran umum aktivitas salin yang menyajikan gambaran umum aktivitas salin.

Penting

Konektor Square versi 1.0 berada pada tahap penghapusan. Anda disarankan untuk meningkatkan konektor Square dari versi 1.0 ke 2.0.

Kemampuan yang didukung

Konektor Square ini didukung untuk kemampuan berikut:

Kemampuan yang didukung IR
Aktivitas menyalin (sumber/-) (1) (2)
Aktivitas pencarian (1) (2)

(1) Azure runtime integrasi (2) Runtime integrasi yang dihost sendiri

Untuk daftar penyimpanan data yang didukung sebagai sumber/sink, lihat tabel Penyimpanan data yang didukung.

Layanan ini menyediakan driver bawaan untuk mengaktifkan konektivitas, oleh karena itu Anda tidak perlu memasang driver apa pun secara manual menggunakan konektor ini.

Konektor mendukung versi Windows dalam article ini.

Prasyarat

Jika penyimpanan data Anda terletak di dalam jaringan lokal, jaringan virtual Azure, atau Amazon Virtual Private Cloud, Anda perlu mengonfigurasi runtime integrasi yang dihosting sendiri self-hosted integration runtime untuk menyambungkannya.

Jika penyimpanan data Anda adalah layanan data cloud terkelola, Anda dapat menggunakan Azure Integration Runtime. Jika akses dibatasi untuk IP yang disetujui dalam aturan firewall, Anda dapat menambahkan IP Azure Integration Runtime ke daftar izinkan.

Anda juga dapat menggunakan fitur managed virtual network integration runtime di Azure Data Factory untuk mengakses jaringan di lokasi tanpa menginstal dan mengonfigurasi runtime integrasi yang dihosting sendiri.

Untuk informasi selengkapnya tentang mekanisme dan opsi keamanan jaringan yang didukung oleh Data Factory, lihat Strategi akses data.

Catatan

Versi 2.0 didukung dengan runtime integrasi yang dihost sendiri versi 5.56.0.0 atau lebih tinggi.

Memulai

Untuk melakukan aktivitas salin dengan alur, Anda dapat menggunakan salah satu alat atau SDK berikut:

Membuat layanan tertaut ke Square menggunakan UI

Gunakan langkah-langkah berikut untuk membuat layanan tertaut ke Square di UI portal Azure.

  1. Telusuri ke tab Kelola di ruang kerja Azure Data Factory atau Synapse Anda dan pilih Layanan Tertaut, lalu klik Baru:

  2. Cari Square dan pilih konektor Square.

    Cuplikan layar konektor Square.

  3. Konfigurasikan detail layanan, uji koneksi, dan buat layanan tertaut baru.

    Screenshot konfigurasi layanan tertaut untuk Square.

Detail konfigurasi konektor

Bagian berikut memberikan detail tentang properti yang digunakan untuk menentukan entitas Data Factory khusus untuk konektor Square.

Properti layanan terhubung

Konektor Square sekarang mendukung versi 2.0. Lihat bagian ini untuk meningkatkan versi konektor Square Anda dari versi 1.0. Untuk detail properti, lihat bagian yang sesuai.

Versi 2.0

Layanan tertaut Square mendukung properti berikut saat menerapkan versi 2.0:

Properti Deskripsi Wajib
jenis Properti type harus diatur ke: Square Ya
versi Versi yang Anda tentukan. Nilainya adalah 2.0. Ya
host Alamat URL dari instance Square. (yaitu mystore.mysquare.com) Ya
clientId ID klien yang terkait dengan aplikasi Square Anda. Ya
clientSecret Rahasia klien yang terkait dengan aplikasi Square Anda. Tandai bidang ini sebagai SecureString untuk menyimpannya dengan aman, atau referensi rahasia yang disimpan di Azure Key Vault. Ya
accessToken Token akses yang diperoleh dari Square. Memberikan akses terbatas ke akun Square dengan meminta pengguna yang diautentikasi untuk izin eksplisit. Token akses OAuth kedaluwarsa 30 hari setelah diterbitkan, tetapi token refresh tidak kedaluwarsa. Token akses dapat disegarkan dengan token refresh.
Tandai bidang ini sebagai SecureString untuk menyimpannya dengan aman, atau referensi rahasia yang disimpan di Azure Key Vault. Untuk informasi selengkapnya tentang jenis token akses, lihat Jenis token akses.
Ya
refreshToken Token refresh yang diperoleh dari Square. Digunakan untuk mendapatkan token akses baru ketika token akses saat ini kedaluwarsa.
Tandai bidang ini sebagai SecureString untuk menyimpannya dengan aman, atau membuat referensi rahasia yang disimpan di Azure Key Vault.
Tidak
connectVia Integration Runtime yang akan digunakan untuk menyambungkan ke penyimpanan data. Jika tidak ditentukan, ia menggunakan Azure Integration Runtime default. Anda dapat menggunakan runtime integrasi yang dihost sendiri dan versinya harus 5.56.0.0 atau lebih tinggi. Tidak

Contoh:

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

Versi 1.0

Layanan tertaut Square mendukung properti berikut saat menerapkan versi 1.0:

Properti Deskripsi Wajib
jenis Properti type harus diatur ke: Square Ya
Properti Koneksi Grup properti yang menentukan cara tersambung ke Square. Ya
Di bawah connectionProperties:
host Alamat URL dari instance Square. (yaitu mystore.mysquare.com) Ya
clientId ID klien yang terkait dengan aplikasi Square Anda. Ya
clientSecret Rahasia klien yang terkait dengan aplikasi Square Anda. Tandai bidang ini sebagai SecureString untuk menyimpannya dengan aman, atau referensi rahasia yang disimpan di Azure Key Vault. Ya
accessToken Token akses yang diperoleh dari Square. Memberikan akses terbatas ke akun Square dengan meminta pengguna yang diautentikasi untuk izin eksplisit. Token akses OAuth kedaluwarsa 30 hari setelah diterbitkan, tetapi token refresh tidak kedaluwarsa. Token akses dapat disegarkan dengan token refresh.
Tandai bidang ini sebagai SecureString untuk menyimpannya dengan aman, atau referensi rahasia yang disimpan di Azure Key Vault. Untuk informasi selengkapnya tentang jenis token akses, lihat Jenis token akses.
Ya
refreshToken Token refresh yang diperoleh dari Square. Digunakan untuk mendapatkan token akses baru ketika token akses saat ini kedaluwarsa.
Tandai bidang ini sebagai SecureString untuk menyimpannya dengan aman, atau membuat referensi rahasia yang disimpan di Azure Key Vault.
Tidak
gunakanEndpointTerenkripsi Menentukan apakah titik akhir sumber data dienkripsi menggunakan HTTPS. Nilai defaultnya adalah true. Tidak
useHostVerification Menentukan apakah mewajibkan nama host di sertifikat server agar sesuai dengan nama host server saat menyambungkan melalui TLS. Nilai defaultnya adalah true. Tidak
usePeerVerification Menentukan apakah akan memverifikasi identitas server ketika menyambungkan melalui TLS. Nilai defaultnya adalah true. Tidak
connectVia Integration Runtime yang akan digunakan untuk menyambungkan ke penyimpanan data. Jika tidak ditentukan, ia menggunakan Azure Integration Runtime default. Tidak

Contoh:

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

Jenis token akses

Square mendukung dua jenis token akses: pribadi dan OAuth.

  • Token akses pribadi digunakan untuk mendapatkan akses API Connect tanpa batas ke sumber daya di akun Square Anda sendiri.

  • Token akses OAuth digunakan untuk mendapatkan akses API Connect yang diautentikasi dan tercakup ke akun Square mana pun. Gunakan saat aplikasi Anda mengakses sumber daya di akun Square lain atas nama pemilik akun. Token akses OAuth juga dapat digunakan untuk mengakses sumber daya di akun Square Anda sendiri.

    Penting

    Untuk melakukan Uji koneksi di layanan tertaut, MERCHANT_PROFILE_READ diperlukan untuk mendapatkan token akses OAuth tercakup. Untuk mendapatkan hak akses ke tabel lain, lihat Referensi Hak Akses OAuth Square.

Autentikasi melalui token akses pribadi hanya memerlukan accessToken, sementara autentikasi melalui OAuth memerlukan accessToken dan refreshToken. Pelajari cara mengambil token akses dari sini.

Properti himpunan data

Untuk daftar lengkap bagian dan properti yang tersedia untuk menentukan himpunan data, lihat artikel himpunan data. Bagian ini menyediakan daftar properti yang didukung oleh himpunan data Square.

Untuk menyalin data dari Square, atur properti type himpunan data ke SquareObject. Berikut adalah properti yang didukung:

Properti Deskripsi Wajib
jenis Properti type himpunan data harus diatur ke: SquareObject Ya
tableName Nama tabel. Ya untuk versi 2.0.
Tidak untuk versi 1.0 (jika "kueri" di sumber aktivitas ditentukan)

Contoh

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

Properti Aktivitas Salin

Untuk daftar lengkap bagian dan properti yang tersedia untuk menentukan aktivitas, lihat artikel Pipelines. Bagian ini menyediakan daftar properti yang didukung oleh sumber Square.

Square sebagai sumber

Untuk menyalin data dari Square, atur jenis sumber dalam aktivitas salin ke SquareSource. Berikut ini properti yang didukung di bagian sumber aktivitas salin:

Properti Deskripsi Wajib
jenis Properti jenis dari sumber aktivitas menyalin harus disetel ke: SquareSource Ya
kueri Gunakan kueri SQL kustom untuk membaca data. Misalnya: "SELECT * FROM Business". Tidak (jika "tableName" dalam dataset ditentukan)

Catatan

query tidak didukung dalam versi 2.0.

Contoh:

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

Pemetaan jenis data untuk Square

Saat Anda menyalin data dari Square, pemetaan berikut berlaku dari jenis data Square ke jenis data internal yang digunakan oleh layanan. Untuk memahami bagaimana aktivitas penyalinan memetakan skema sumber dan jenis data ke tujuan, lihat Pemetaan skema dan jenis data.

Tipe data persegi Jenis data layanan sementara (untuk versi 2.0) Jenis data layanan sementara (untuk versi 1.0)
String String String
Integer Int32 Int32
Long Int64 Int64
Boolean Boolean Boolean
Tanggal String Tidak didukung.
Penanda Waktu String Tidak didukung.
Tanda waktu dengan offset String Tidak didukung.
Durasi (penuh) String String
Durasi (hanya waktu) String String
Uang Int64 Int64

Properti aktivitas pencarian Lookup

Untuk mempelajari detail tentang properti, lihat Aktivitas pencarian.

Siklus hidup dan peningkatan konektor persegi

Tabel berikut menunjukkan tahap rilis dan catatan perubahan untuk berbagai versi konektor Square:

Versi Tahap rilis Riwayat Perubahan
Versi 1.0 Removed Tidak dapat diterapkan.
Versi 2.0 Ketersediaan Umum • Versi runtime integrasi yang dihost sendiri harus 5.56.0.0 atau lebih tinggi.

• Tanggal, Tanda Waktu, dan Tanda Waktu dengan offset dibaca sebagai jenis data String.

useEncryptedEndpoints, useHostVerification, usePeerVerification tidak didukung dalam layanan tertaut.

query tidak didukung.

Tingkatkan konektor Square dari versi 1.0 ke versi 2.0

  1. Di halaman Edit layanan tertaut, pilih 2.0 untuk versi. Untuk informasi selengkapnya, lihat properti layanan tertaut versi 2.0.

  2. Pemetaan jenis data untuk layanan tertaut Square versi 2.0 berbeda dari yang untuk versi 1.0. Untuk mempelajari pemetaan jenis data terbaru, lihat Pemetaan jenis data untuk Square.

  3. Terapkan runtime integrasi yang dihost sendiri dengan versi 5.56.0.0 atau lebih tinggi.

  4. query hanya didukung dalam versi 1.0. Anda harus menggunakan tableName daripada query di versi 2.0.

Untuk daftar penyimpanan data yang didukung sebagai sumber dan sink oleh aktivitas salin, lihat penyimpanan data yang didukung.