This project is currently in Beta. Please open up an issue here to report issues using the MX Platform Ruby library.

MX Platform Ruby

The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.

Documentation

Examples for the API endpoints can be found here.

Requirements

Ruby >= 2.6

Installation

Add this line to your application's Gemfile:

gem 'mx-platform-ruby'

And then execute:

bundle

Or install it yourself with:

gem install mx-platform-ruby

Getting Started

In order to make requests, you will need to sign up for the MX Platform API and get a Client ID and API Key.

Please follow the installation procedure and then run the following code to create your first User:

require 'mx-platform-ruby'

::MxPlatformRuby.configure do |config|
  # Configure with your Client ID/API Key from https://dashboard.mx.com
  config.username = 'Your Client ID'
  config.password = 'Your API Key'

  # Configure environment. 0 for production, 1 for development
  config.server_index = 1
end

api_client = ::MxPlatformRuby::ApiClient.new
api_client.default_headers['Accept'] = 'application/vnd.mx.api.v1+json'
mx_platform_api = ::MxPlatformRuby::MxPlatformApi.new(api_client)

request_body = ::MxPlatformRuby::UserCreateRequestBody.new(
  user: ::MxPlatformRuby::UserCreateRequest.new(
    metadata: 'Creating a user!'
  )
)

begin
  response = mx_platform_api.create_user(request_body)
  p response
rescue ::MxPlatformRuby::ApiError => e
  puts "Error when calling MxPlatformApi->create_user: #{e}"
end

Development

This project was generated by the OpenAPI Generator. To generate this library, verify you have the latest version of the openapi-generator-cli found here.

Running the following command in this repo's directory will generate this library using the MX Platform API OpenAPI spec with our configuration and templates.

openapi-generator-cli generate \
-i https://raw.githubusercontent.com/mxenabled/openapi/master/openapi/mx_platform_api.yml \
-g ruby \
-c ./openapi/config.yml \
-t ./openapi/templates

Contributing

Please open an issue or submit a pull request.

mxenabled / mx-platform-ruby

readme