Skip to content

Mifiel/ruby-api-client

Repository files navigation

Mifiel

Gem Version Build Status Coverage Status

Ruby SDK for Mifiel API. Please read our documentation for instructions on how to start using the API.

Installation

Add this line to your application's Gemfile:

gem 'mifiel'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mifiel

Usage

Follow the steps in our documentation to create an account and get your access tokens, then you can configure the gem with:

  Mifiel.config do |config|
    config.app_id = '<APP_ID>'
    config.app_secret = '<APP_SECRET>'
    # remove the next line when you wish to use the prod environment
    config.base_url = 'https://app-sandbox.mifiel.com/api/v1'
  end

Contributing

  1. Fork it ( https://github.com/[my-github-username]/mifiel/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request