Эта библиотека обеспечивает поддержку приложений Ruby Shopify для доступа к API Shopify Admin, облегчая выполнение следующих действий:
В дополнение к API администратора, эта библиотека также позволяет запросить API магазина.
Вы можете использовать эту библиотеку в любом приложении, которое имеет бэкэнд Ruby, поскольку она не полагается на какую -либо конкретную структуру - вы можете включить ее вместе со своим предпочтительным стеком и использовать функции, необходимые для создания вашего приложения.
Примечание . Эти инструкции применимы к V10 или более поздней части этого пакета. Если вы запускаете V9 в своем приложении, вы можете найти документацию в этой филиале.
При использовании в рамках Rails мы настоятельно рекомендуем использовать Gem Shopify_App для взаимодействия с этим драгоценным камнем. Аутентификация, хранение сеансов, регистрация Webhook и другие часто реализованные пути управляются в этом GEM с простыми в использовании конфигураций.
Чтобы следовать этим руководствам об использовании, вам нужно:
Добавьте следующее в свой Gemfile:
gem " shopify_api "или используйте бундлер:
bundle add shopify_api Начните с инициализации 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, как описано здесь, чтобы создать сеансы для магазинов, используя ваше приложение. Gem Shopify API пытается сделать это проще, предоставив функции для начала и завершения процесса OAuth. Смотрите документ OAuth для инструкций о том, как их использовать.
Если вы собираетесь использовать WebHooks в своем приложении, выполните шаги в документе WebHooks для инструкций по регистрации и обработке 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, чтобы Lint/Format кода. Вы можете запустить его со следующей командой:
bundle exec rubocop
