Installation

Prerequisites

• Ruby 3.2 or newer (the gemspec sets required_ruby_version = ">= 3.2").
• An Easy Labs API key. Use a sk_test_… key against the sandbox or a sk_live_… key against production. The SDK picks the correct base URL from the prefix automatically.
• The gem depends on multipart-post (~> 2.4) for the file-upload paths (dispute evidence, recipient imports). Everything else uses Ruby's stdlib Net::HTTP.

Install the package

With Bundler:

# Gemfile
gem "easy-sdk", "~> 0.1"

bundle install

Without Bundler:

gem install easy-sdk

Verify the install

require "easy_sdk"

client = EasyLabs::Client.new(api_key: ENV.fetch("EASY_API_KEY"))

# The constructor calls GET /validate-key, so reaching this line means
# the key is valid and the SDK can reach the API.
puts "Connected to #{client.api_url}"

If the key is malformed or rejected, EasyLabs::Client.new raises EasyLabs::AuthenticationError immediately — no lazy first-call surprise.

Next steps

• Quickstart — render your first payment.
• Authentication — API keys, sandbox vs. live, multi-tenant clients.
• Resources — every method on every resource.