{"repo":"bigcommerce/bigcommerce-api-ruby","free":true,"listed":false,"github":"https://github.com/bigcommerce/bigcommerce-api-ruby","clone":"git clone https://github.com/bigcommerce/bigcommerce-api-ruby.git","description":"Connect Ruby applications with the Bigcommerce Platform","language":"Ruby","stars":82,"topics":["ruby","bigcommerce","oauth","api-client"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"BigCommerce API Ruby This is the official BigCommerce API client to support our Stores API. You can find more information about becoming a BigCommerce developer on the docs site. Installation BigCommerce is available on RubyGems. You can also add it to your Gemfile. Requirements - Ruby 2.7.5 or newer (Ruby 3.0+ is preferred) Getting Started To make requests to our API, you must register as a developer and have your credentials ready. Also very important: For the OAuth authentication mechanism, the resources to which you have acccess depend on the scopes that the merchant has granted to your application. For more information about Store API scopes, see: OAuth Scopes. Authentication We currently have two different authentication schemes that you can select, depending on your use case. OAuth OAuth apps can be submitted to BigCommerce App Store, allowing other merchants to install these apps in their BigCommerce stores. More Information Configuration To authenticate your API client, you will need to configure the client like the following examples. OAuth App - client id : Obtained from the on the BigCommerce Developer Portal's Apps section. - access token : Obtained after a token exchange in the auth callback. - store hash : Also obtained after the token exchange. Basic Authentication (Legacy) To get all the basic auth credentials, simply visit your store admin page, and navigate to the Advanced Settings Legacy API Settings . Once there, you can create a new legacy API account on","default_branch":null,"files":null,"tree":[],"storefront":"/r/bigcommerce","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/bigcommerce/bigcommerce-api-ruby/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}