หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

Shopify API Library สำหรับทับทิม

สร้างสถานะ

ห้องสมุดนี้ให้การสนับสนุนแอพ Ruby Shopify เพื่อเข้าถึง Shopify Admin API โดยทำให้การดำเนินการดังต่อไปนี้ง่ายขึ้น:

  • การสร้างโทเค็นการเข้าถึงออนไลน์หรือออฟไลน์สำหรับ ADMIN API ผ่าน OAuth
  • ทำการร้องขอไปยังส่วนที่เหลือ API
  • ทำการร้องขอไปยัง GraphQL API
  • การลงทะเบียน/ประมวลผล webhooks

นอกจาก API ผู้ดูแลระบบแล้วไลบรารีนี้ยังอนุญาตให้สืบค้น API หน้าร้าน

คุณสามารถใช้ไลบรารีนี้ในแอปพลิเคชันใด ๆ ที่มีแบ็กเอนด์ทับทิมเนื่องจากไม่พึ่งพากรอบการทำงานเฉพาะใด ๆ - คุณสามารถรวมไว้ข้างสแต็กที่คุณต้องการและใช้คุณสมบัติที่คุณต้องการในการสร้างแอปของคุณ

หมายเหตุ : คำแนะนำเหล่านี้ใช้กับ V10 หรือใหม่กว่าของแพ็คเกจนี้ หากคุณใช้งาน V9 ในแอพของคุณคุณสามารถค้นหาเอกสารในสาขานี้

ใช้กับราง

หากใช้ในกรอบ Rails เราขอแนะนำให้คุณใช้ Gem Shopify_app เพื่อโต้ตอบกับอัญมณีนี้ การรับรองความถูกต้องการจัดเก็บเซสชันการลงทะเบียน webhook และเส้นทางที่ใช้งานบ่อยอื่น ๆ ได้รับการจัดการในอัญมณีนั้นด้วยการกำหนดค่าที่ใช้งานง่าย

ความต้องการ

ในการติดตามคู่มือการใช้งานเหล่านี้คุณจะต้อง:

  • มีความรู้เกี่ยวกับทับทิมและกรอบเว็บเช่นรางหรือซินาตร้า
  • มีบัญชีคู่ค้าและร้านค้าพัฒนาร้านค้า
  • มีแอพตั้งค่าอยู่แล้วในร้านทดสอบหรือบัญชีพันธมิตรของคุณ
  • เพิ่ม URL และการเปลี่ยนเส้นทางที่เหมาะสมสำหรับเส้นทางโทรกลับ OAuth ของคุณไปยังการตั้งค่าแอปของคุณ

การติดตั้ง

เพิ่มสิ่งต่อไปนี้ใน Gemfile ของคุณ: 

gem " shopify_api "

หรือใช้ Bundler: 

bundle add shopify_api

ขั้นตอนในการใช้อัญมณี

การตั้งค่าบริบท Shopify

เริ่มต้นด้วยการเริ่มต้น ShopifyAPI::Context ด้วยพารามิเตอร์ของแอปของคุณโดยการโทร ShopifyAPI::Context.setup (ตัวอย่างด้านล่าง) เมื่อแอปของคุณเริ่มต้น (เช่น application.rb ในแอพ Rails) 

 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
)

การแสดง Oauth

คุณต้องผ่าน OAuth ตามที่อธิบายไว้ที่นี่เพื่อสร้างเซสชันสำหรับร้านค้าที่ใช้แอพของคุณ Shopify API Gem พยายามทำให้ง่ายขึ้นโดยการจัดหาฟังก์ชั่นเพื่อเริ่มต้นและทำกระบวนการ OAuth ให้เสร็จสมบูรณ์ ดูเอกสาร OAUTH สำหรับคำแนะนำเกี่ยวกับวิธีการใช้สิ่งเหล่านี้

ลงทะเบียน webhooks และ handler webhook

หากคุณตั้งใจจะใช้ webhooks ในแอปพลิเคชันของคุณทำตามขั้นตอนในเอกสาร WebHooks สำหรับคำแนะนำในการลงทะเบียนและจัดการ webhooks

เริ่มทำคำขอ API Shopify ที่ผ่านการรับรองความถูกต้อง

เมื่อแอปของคุณสามารถดำเนินการ OAuth ได้ตอนนี้สามารถทำการโทร API Shopify ที่ผ่านการรับรองได้แล้วดูเอกสารสำหรับ:

  • ขอให้ผู้ดูแลระบบ REST API คำขอ
  • การร้องขอ Admin GraphQL API
  • ทำคำขอ storefront graphql api

ทำลายประกาศการเปลี่ยนแปลง

แจ้งเตือนการเปลี่ยนแปลงสำหรับเวอร์ชัน 15.0.0

ดู breaking_changes_for_v15

แจ้งเตือนการเปลี่ยนแปลงสำหรับเวอร์ชัน 10.0.0

ดู breaking_changes_for_v10

ทำลายการเปลี่ยนแปลงสำหรับรุ่นเก่า

ดู breaking_changes_for_older_versions

การพัฒนาอัญมณีนี้

หลังจากโคลนนิ่งที่เก็บคุณสามารถติดตั้งการอ้างอิงด้วย Bundler: 

bundle install

ในการเรียกใช้การทดสอบอัตโนมัติ: 

bundle exec rake test

เราใช้ Rubocop เพื่อผ้าสำลี/จัดรูปแบบรหัส คุณสามารถเรียกใช้ด้วยคำสั่งต่อไปนี้: 

bundle exec rubocop
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด