bigcommerce-api-ruby - GitLite

KO | EN

gitlite — search

#javascript #llm #go #machine-learning #rust #macos #nodejs #windows #cli #vue #awesome-list #pytorch #openai #open-source

bigcommerce-api-ruby

(★ 82)

Connect Ruby applications with the Bigcommerce Platform

File Explorer

Download Latest Version (.zip)

- config.yml
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- console
- setup
- - legacy_auth.rb
  - oauth.rb
- - blog_post.rb
  - blog_tag.rb
  - redirect.rb
- - customer.rb
  - customer_address.rb
  - customer_group.rb
  - customer_login.rb
- - country.rb
  - state.rb
- - banner.rb
  - coupon.rb
  - gift_certificates.rb
- - order.rb
  - order_coupon.rb
  - order_message.rb
  - order_product.rb
  - order_shipping_address.rb
  - order_status.rb
  - order_tax.rb
  - shipment.rb
- - payment_method.rb
- - brand.rb
  - bulk_pricing_rule.rb
  - category.rb
  - configurable_field.rb
  - custom_field.rb
  - google_product_search_mapping.rb
  - option.rb
  - option_set.rb
  - option_set_option.rb
  - option_value.rb
  - product.rb
  - product_image.rb
  - product_option.rb
  - product_review.rb
  - product_rule.rb
  - product_video.rb
  - sku.rb
- - shipping_method.rb
- - store_info.rb
- - time.rb
- - tax_class.rb
- - webhook.rb
- exception_handling.rb
- README.md
- - config.rb
  - connection.rb
  - exception.rb
  - path_builder.rb
  - request.rb
  - resource_actions.rb
  - subresource_actions.rb
  - version.rb
- bigcommerce.rb
- - bigcommerce_spec.rb
- - helpers.rb
- simplecov_helper.rb
- spec_helper.rb
.gitignore
.rspec
.rubocop.yml
bigcommerce.gemspec
CHANGELOG.md
CONTRIBUTING.md
DEPENDENCIES.md
Gemfile
LICENSE.md
Rakefile
README.md
RELEASING.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BigCommerce API Ruby

[![Gem Version](https://badge.fury.io/rb/bigcommerce.svg)](https://rubygems.org/gems/bigcommerce)
[![CircleCI](https://circleci.com/gh/bigcommerce/bigcommerce-api-ruby/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/bigcommerce-api-ruby/tree/master)
[![Test Coverage](https://api.codeclimate.com/v1/badges/d1ba1b74a2a74a26e8b4/test_coverage)](https://codeclimate.com/github/bigcommerce/bigcommerce-api-ruby/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/d1ba1b74a2a74a26e8b4/maintainability)](https://codeclimate.com/github/bigcommerce/bigcommerce-api-ruby/maintainability)

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](https://docs.bigcommerce.com).

## Installation

BigCommerce is available on [RubyGems](https://rubygems.org/gems/bigcommerce).

```sh
gem install bigcommerce
```

You can also add it to your Gemfile.

```rb
gem 'bigcommerce', '~> 1.0'
```

## 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](https://docs.bigcommerce.com/developer/docs/overview/api-fundamentals/api-accounts#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](https://www.bigcommerce.com/apps), allowing other merchants to install these apps in their
BigCommerce stores.

**[More Information](https://docs.bigcommerce.com/developer/docs/overview/api-fundamentals/api-accounts#authentication)**

## 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](https://build.bigcommerce.com) Apps section.
- `access_token`: Obtained after a token exchange in the auth callback.
- `store_hash`: Also obtained after the token exchange.

```rb
Bigcommerce.configure do |config|
  config.store_hash = ENV['BC_STORE_HASH']
  config.client_id = ENV['BC_CLIENT_ID']
  config.access_token = ENV['BC_ACCESS_TOKEN']
end
```

### 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 which to authenticate.

```rb
Bigcommerce.configure do |config|
  config.auth = 'legacy'
  config.url = ENV['BC_API_ENDPOINT_LEGACY']
  config.username = ENV['BC_USERNAME']
  config.api_key = ENV['BC_API_KEY']
end
```

**SSL Configuration**

If you are using your own, self-signed, certificate, you can pass SSL options to Faraday. This is not required, but
might be useful in special edge cases.

```rb
Bigcommerce.configure do |config|
  config.auth = 'legacy'
  config.url = 'https://api_path.com'
  config.username = 'username'
  config.api_key = 'api_key'
  config.ssl = {
    # Faraday options here
  }
end
```

For more information about configuring SSL with Faraday, please see the following:

- [Faraday SSL example](https://gist.github.com/mislav/938183)
- [Faraday: Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates)

### Customer Login API

If you want to generate tokens for storefront login using the Customer Login API, you need to configure your app's
client secret.

- `store_hash`: The store hash of the store you are operating against.
- `client_id`: Obtained from the on the BigCommerce [Developer Portal's](https://build.bigcommerce.com) Apps section.
- `client_secret`: Obtained from the on the BigCommerce [Developer Portal's](https://build.bigcommerce.com) Apps section.

```rb
Bigcommerce.configure do |config|
  config.store_hash = ENV['BC_STORE_HASH']
  config.client_id = ENV['BC_CLIENT_ID']
  config.client_secret = ENV['BC_CLIENT_SECRET']
end
```

## Usage

For full examples of using the API client, please see the [examples folder](examples) and refer to
BigCommerce's [developer documentation](https://docs.bigcommerce.com/).

Example:

```rb
# Configure the client to talk to a given store
Bigcommerce.configure do |config|
  config.store_hash = ENV['BC_STORE_HASH']
  config.client_id = ENV['BC_CLIENT_ID']
  config.access_token = ENV['BC_ACCESS_TOKEN']
end

# Make an API request for a given resource
Bigcommerce::System.time
=> #<Bigcommerce::System time=1466801314>
```

### Thread Safety

The `Bigcommerce.configure` method is NOT thread-safe. This mechanism is designed for applications or
CLIs (command-line interfaces) where thread safety is not a concern. If you need to guarantee thread safety, we support
this alternative mechanism to make thread-safe API requests:

Rather then setting up a single `connection` for all API requests, construct a new connection for each thread.
If you can ensure that each of these connections is stored in a thread-safe manner, you can pass the `connection` as
you query the resource.

This connection is nothing more than a `Faraday::Connection` – so if you want to write your own, or to use your own
adapters, you can feel free. Please refer to this gem's [connection class](https://github.com/bigcommerce/bigcommerce-api-ruby/blob/master/lib/bigcommerce/connection.rb) for more details.

##### OAuth

```rb
connection = Bigcommerce::Connection.build(
  Bigcommerce::Config.new(
    store_hash: ENV['BC_STORE_HASH'],
    client_id: ENV['BC_CLIENT_ID'],
    access_token: ENV['BC_ACCESS_TOKEN']
  )
)
=> #<Faraday::Connection:0x007fbf95068978 ... >>

Bigcommerce::System.time(connection: connection)
=> #<Bigcommerce::System time=1466546702>

Bigcommerce::System.raw_request(:get, 'time', connection: connection)
=> #<Faraday::Response:0x007fd4a4063170 ... >>
```

##### Basic Auth

```rb
connection_legacy = Bigcommerce::Connection.build(
  Bigcommerce::Config.new(
    auth: 'legacy',
    url: ENV['BC_API_ENDPOINT_LEGACY'],
    username: ENV['BC_USERNAME'],
    api_key: ENV['BC_API_KEY']
  )
)
=> #<Faraday::Connection:0x007fbf95068978 ... >>

Bigcommerce::System.time(connection: connection_legacy)
=> #<Bigcommerce::System time=1466546702>

Bigcommerce::System.raw_request(:get, 'time', connection: connection_legacy)
=> #<Faraday::Response:0x007fd4a4063170 ... >>
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

See [LICENSE.md](LICENSE.md)