이 라이브러리는 Ruby Shopify 앱을 지원하여 Shopify Admin API에 액세스하여 다음 작업을보다 쉽게 수행 할 수 있습니다.
관리자 API 외에도이 라이브러리를 사용하면 Storefront API를 쿼리 할 수 있습니다.
Ruby 백엔드가있는 모든 응용 프로그램 에서이 라이브러리를 사용할 수 있습니다. 특정 프레임 워크에 의존하지 않으므로 선호하는 스택과 함께 포함하여 앱을 빌드하는 데 필요한 기능을 사용할 수 있습니다.
참고 :이 지침은이 패키지의 v10 이상에 적용됩니다. 앱에서 V9를 실행중인 경우이 지점에서 문서를 찾을 수 있습니다.
Rails 프레임 워크에서 사용하는 경우 Shopify_app 보석을 사용 하여이 보석과 상호 작용하는 것이 좋습니다. 인증, 세션 스토리지, Webhook 등록 및 기타 자주 구현되는 경로는 사용하기 쉬운 구성으로 보석에서 관리됩니다.
이 사용 가이드를 따르려면 다음을 수행해야합니다.
Gemfile에 다음을 추가하십시오.
gem " shopify_api "또는 Bundler 사용 :
bundle add shopify_api ShopifyAPI::Context ShopifyAPI::Context.setup 를 초기화하여 시작하십시오 (예 : Rails 앱에서 application.rb ).
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를 통과해야합니다. Shopify API Gem은 OAUTH 프로세스를 시작하고 완료하는 기능을 제공함으로써이를 쉽게 만들려고합니다. 사용 방법에 대한 지침은 Oauth Doc을 참조하십시오.
응용 프로그램에서 webhooks를 사용하려는 경우 Webhooks Doc의 단계를 따르면 WebHooks 등록 및 처리에 대한 지침이 있습니다.
앱이 Oauth를 수행 할 수 있으면 이제 인증 된 Shopify API 호출을 만들 수 있습니다. 문서를 참조하십시오.
breaking_changes_for_v15를 참조하십시오
breaking_changes_for_v10을 참조하십시오
breaking_changes_for_older_versions를 참조하십시오
저장소를 복제 한 후 Bundler를 사용하여 종속성을 설치할 수 있습니다.
bundle install자동 테스트를 실행하려면 :
bundle exec rake test우리는 Rubocop을 사용하여 코드를 보풀/형식으로 지정합니다. 다음 명령으로 실행할 수 있습니다.
bundle exec rubocop
