Unduh shopify api ruby - shopify api ruby Source Code Unduh

shopify api ruby

Kode sumber lainnya

Unduh

Perpustakaan API Shopify untuk Ruby

Bangun status

Perpustakaan ini memberikan dukungan untuk aplikasi Ruby Shopify untuk mengakses API Admin Shopify, dengan memudahkan melakukan tindakan berikut:

Membuat token akses online atau offline untuk API admin melalui oauth
Membuat permintaan ke API REST
Membuat permintaan ke graphql API
Mendaftarkan/memproses webhooks

Selain API admin, perpustakaan ini juga memungkinkan permintaan API etalase.

Anda dapat menggunakan perpustakaan ini dalam aplikasi apa pun yang memiliki backend ruby, karena tidak bergantung pada kerangka kerja tertentu - Anda dapat memasukkannya di samping tumpukan pilihan Anda dan menggunakan fitur yang Anda butuhkan untuk membangun aplikasi Anda.

Catatan : Instruksi ini berlaku untuk V10 atau lebih baru dari paket ini. Jika Anda menjalankan V9 di aplikasi Anda, Anda dapat menemukan dokumentasi di cabang ini.

Gunakan dengan rel

Jika menggunakan dalam kerangka kerja Rails, kami sangat menyarankan Anda menggunakan permata Shopify_app untuk berinteraksi dengan permata ini. Otentikasi, penyimpanan sesi, pendaftaran webhook, dan jalur lain yang sering diimplementasikan dikelola dalam permata itu dengan konfigurasi yang mudah digunakan.

Persyaratan

Untuk mengikuti panduan penggunaan ini, Anda perlu:

memiliki pengetahuan tentang ruby dan kerangka kerja web seperti rails atau sinatra
Miliki Akun Mitra dan Toko Pengembangan Shopify
Siapkan aplikasi yang sudah diatur di toko tes atau mitra Anda
Tambahkan URL dan redirect yang sesuai untuk rute panggilan balik oAuth Anda ke pengaturan aplikasi Anda

Instalasi

Tambahkan yang berikut ke gemfile Anda:

gem " shopify_api "

Atau gunakan Bundler:

bundle add shopify_api

Langkah untuk menggunakan permata

Siapkan konteks Shopify

Mulailah dengan menginisialisasi ShopifyAPI::Context dengan parameter aplikasi Anda dengan menelepon ShopifyAPI::Context.setup (contoh di bawah) ketika aplikasi Anda dimulai (misalnya application.rb dalam aplikasi rel).

 ShopifyAPI :: Context . setup (
  api_key : "<api-key>" ,
  api_secret_key : "<api-secret-key>" ,
  host : "<https://application-host-name.com>" ,
  scope : "read_orders,read_products,etc" ,
  is_embedded : true , # Set to true if you are building an embedded app
  api_version : "2022-01" , # The version of the API you would like to use
  is_private : false , # Set to true if you have an existing private app
)

Melakukan oauth

Anda harus melalui OAuth seperti yang dijelaskan di sini untuk membuat sesi untuk toko -toko menggunakan aplikasi Anda. Permata API Shopify mencoba memudahkan ini dengan menyediakan fungsi untuk memulai dan menyelesaikan proses OAuth. Lihat OAuth Doc untuk instruksi tentang cara menggunakan ini.

Daftarkan Webhooks dan Handler Webhook

Jika Anda bermaksud menggunakan webhooks di aplikasi Anda, ikuti langkah -langkah di WebHooks Doc untuk instruksi untuk mendaftar dan menangani Webhooks.