Sha256: ff6525b57782ae7c551e4a25de2586de06e6bcf8cb180708a1ed2771d9fab29f
Contents?: true
Size: 1.07 KB
Versions: 7
Compression:
Stored size: 1.07 KB
Contents
# Atrium-Ruby
A Ruby wrapper for use with the [MX Atrium API](https://atrium.mx.com). In order to make requests, you will need to [sign up for MX Atrium API](https://atrium.mx.com/developers/sign_up) and get a `MX-API-KEY` and `MX-CLIENT-ID`. Then, configure your instance with:
```ruby
Atrium.configure do |config|
config.mx_api_key = YOUR_API_KEY
config.mx_client_id = YOUR_CLIENT_ID
end
```
From there, you can start using some basic class methods to make calls for data. See our [full documentation](https://atrium.mx.com/documentation) for more details.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'atrium-ruby'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install atrium-ruby
## Development
Suggested implementation flow can be found in `bin/demo` comments. You can also use that as an executable for managing the settings and creating your own test flow to handle the requests and data with `./bin/demo`
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mxenabled/atrium-ruby.
Version data entries
7 entries across 7 versions & 1 rubygems