Skip to main content

​
Installation

Install the Solifyn gem from RubyGems:
Terminal
gem install solifyn
Or add it to your application’s Gemfile:
Gemfile
gem 'solifyn'
And then execute:
Terminal
bundle install

​
Quickstart

Configure Solifyn.configure with your API credentials and instantiate your API client classes.
main.rb
require 'solifyn'

# Configure client credentials
Solifyn.configure do |config|
  config.access_token = 'YOUR_API_KEY' # Replace with your actual Solifyn API key
end

# Create an instance of the Products API
api_instance = Solifyn::ProductsApi.new

begin
  # Retrieve a list of products
  result = api_instance.products_list
  p result
rescue Solifyn::ApiError => e
  puts "Exception when calling ProductsApi->products_list: #{e}"
end

​
API Classes

Endpoint categories are available as separate classes under the Solifyn namespace:
  • Solifyn::ProductsApi - Manage products and addons
  • Solifyn::LicenseApi & Solifyn::LicenseKeysApi - Administer license key records
  • Solifyn::LicenseKeysClientApi - Public client validation (licenses_verify) and activation (licenses_activate)
  • Solifyn::CheckoutApi - Manage checkout sessions
  • Solifyn::CheckoutLinksApi - Generate checkout links
  • Solifyn::CustomersApi - Customer information operations
  • Solifyn::CollectionsApi - Group products in collections
  • Solifyn::SubscriptionsApi - Manage recurring subscription actions
  • Solifyn::DiscountsApi - Create and validate discount coupon codes
  • Solifyn::MetersApi - Ingest metered billing metrics
  • Solifyn::DeveloperApi - Manage API keys and webhooks
  • Solifyn::DigitalFileApi - Handle digital files
  • Solifyn::DisputesApi - Review and upload evidence for transaction disputes
  • Solifyn::OrdersApi - Invoices and customer purchases