First you will need to sign up for a Beyond test shop. Visit our sign up form, fill out the form with your data, and click the Sign up button.
Log in to the cockpit of your test shop, navigate to Apps > Custom apps and click Add custom app. Fill out the form with the App name, Application Callback URL and App scopes. Save your app.
You will then receive your client_id
and client_secret
.
Add this line to your application's Gemfile:
gem "beyond_api"
And then execute:
$ bundle install
Next, you need to run the generator:
$ rails generate beyond_api:install
This will generate the configuration file on config/initializers/beyond_api.rb
. Set the client_id
and client_secret
values to get started.
⚠️ Be careful! Don't expose yourclient_id
andclient_secret
or publish them on GitHub or any other service. Use Rails Credentials or a gem like dotenv to save your environment variables.
To install the gem manually from your shell, run:
$ gem install beyond_api
See GETTING_STARTED for information on consuming the Beyond API.
Check out the repo an run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
.
Please see CONTRIBUTING.
Beyond API's changelog is available here.
beyond_api is Copyright © 2019 ePages GmbH. It is free software, and may be redistributed under the terms specified in the LICENSE file.
As the largest independent provider of online shop software in Europe, ePages specialises in high-performance ecommerce solutions for small and medium-sized businesses. Today, 100,000 companies in 70 countries operate professional online shops with ePages software in the cloud.
And we love open source software! Check out our other projects, or become part of our team and develop great ecommerce software with us!