Esta biblioteca proporciona soporte para las aplicaciones de Ruby Shopify para acceder a la API de Shopify Admin, facilitando la realización de las siguientes acciones:
Además de la API de administración, esta biblioteca también permite consultar la API de la tienda.
Puede usar esta biblioteca en cualquier aplicación que tenga un backend de Ruby, ya que no depende de ningún marco específico: puede incluirla junto con su pila preferida y usar las características que necesita para construir su aplicación.
Nota : Estas instrucciones se aplican al V10 o posterior de este paquete. Si está ejecutando V9 en su aplicación, puede encontrar la documentación en esta rama.
Si usa en el marco Rails, le recomendamos que use la gema Shopify_App para interactuar con esta gema. La autenticación, el almacenamiento de sesiones, el registro de Webhook y otras rutas implementadas con frecuencia se administran en esa gema con configuraciones fáciles de usar.
Para seguir estas guías de uso, deberá:
Agregue lo siguiente a su archivo gem:
gem " shopify_api "
o usar Bundler:
bundle add shopify_api
Comience inicializando el ShopifyAPI::Context
con los parámetros de su aplicación llamando a ShopifyAPI::Context.setup
(ejemplo a continuación) Cuando se inicia su aplicación (por ejemplo, application.rb
en una aplicación 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
)
Debe pasar por OAuth como se describe aquí para crear sesiones para tiendas que usan su aplicación. Shopify API Gem intenta facilitar esto al proporcionar funciones para comenzar y completar el proceso OAuth. Vea el OAuth Doc para obtener instrucciones sobre cómo usarlas.
Si tiene la intención de usar Webhooks en su aplicación, siga los pasos en el Doc.
Una vez que su aplicación puede realizar OAuth, ahora puede hacer llamadas de API de Shopify autenticadas, vea los documentos para:
Ver Breaking_Changes_FOR_V15
Ver Breaking_Changes_FOR_V10
Ver Breaking_Changes_For_older_versions
Después de clonar el repositorio, puede instalar las dependencias con Bundler:
bundle install
Para ejecutar las pruebas automatizadas:
bundle exec rake test
Utilizamos Rubocop para lint/formatear el código. Puede ejecutarlo con el siguiente comando:
bundle exec rubocop