SDKs

Ruby SDK

Official Ruby client for the MUDBASE API.

Installation

bash
gem install mudbase_sdk
gem install mudbase_sdk

Quick Start

Configure MudbaseSDK plus the API classes you need — there is no unified client wrapper:

ruby
require 'mudbase_sdk'

MudbaseSDK.configure do |config|
  config.scheme = 'https'
  config.host = 'cloud.mudbase.dev'
  config.api_key['ApiKeyAuth'] = ENV['MUDBASE_API_KEY']
end

auth = MudbaseSDK::AuthenticationApi.new
data = MudbaseSDK::DataApi.new

# Log in an end-user of your project
login_request = MudbaseSDK::LoginRequest.new({email: 'morgan.chen@northwind.dev', password: 'hunter2'})
session = auth.login_user(login_request)

# List documents in a collection
items = data.list_data(project_id, collection_id)
require 'mudbase_sdk'

MudbaseSDK.configure do |config|
  config.scheme = 'https'
  config.host = 'cloud.mudbase.dev'
  config.api_key['ApiKeyAuth'] = ENV['MUDBASE_API_KEY']
end

auth = MudbaseSDK::AuthenticationApi.new
data = MudbaseSDK::DataApi.new

# Log in an end-user of your project
login_request = MudbaseSDK::LoginRequest.new({email: 'morgan.chen@northwind.dev', password: 'hunter2'})
session = auth.login_user(login_request)

# List documents in a collection
items = data.list_data(project_id, collection_id)

More

For installation in other languages, error handling, and pagination, see the SDKs Overview.