Skip to content
3scale API Ruby Client
Branch: master
Clone or download
Latest commit c2af769 Jun 7, 2019


This gem aims to expose all 3scale APIs with a Ruby interface.


Add this line to your application's Gemfile:

gem '3scale-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install 3scale-api


require '3scale/api'
client = '', provider_key: 'foobar')

services = client.list_services

Get the whole list of methods available from the RDoc site.


Design decisions:

  • 0 runtime dependencies
  • thread safety
  • tested


After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.


To run tests run rake or rspec.

There are two kinds of tests: unit (see spec/api) and integration (see spec/integration).

For running the integration tests you will need to have a real 3scale account, you can set the details of the account via environment variables. The easiest way to set everything up is it to have a .env file in the root of the project with the following environment variables (set your own values):

VERIFY_SSL=true (by default true)

Note: for the tests to pass the following requirements need to be met:

  • the field billing_address should be added to the Account model in Settings > Fields Definitions

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to


Bug reports and pull requests are welcome on GitHub at

You can’t perform that action at this time.