README.md

Circuit REST API Ruby client

Wrapper for the Unify Circuit Rest API

Circuit Documentation

See

• Unify Circuit documentation
• REST API V2 Swagger

Requirements

Ruby 2.0+.

Bundler

source 'https://rubygems.org'

gem 'circuit-api'

Configuration

The library needs to be configured with your account's secret key value:

require 'circuit_api'

CircuitApi::Client.new(
    client_id: 'client id',
    client_secret: 'client secret',
    sandbox: false,
    instance_url: 'https://eu.yourcircuit.com/'
)

client.connect('oauth token')

Usage

Query for the list of webhooks:

webhooks = client.webhooks.all
webhooks.first.id

Development

Run all tests:

bundle exec rspec