Skip to main content

WhatPulse Ruby SDK

The official Ruby SDK lets you access the WhatPulse API from your Ruby applications. It takes care of authentication and API requests for you.

Installation​

Add the gem to your Gemfile:

gem 'whatpulse-sdk'

Then run:

bundle install

Or install directly:

gem install whatpulse-sdk

Authentication​

Get your API key from here.

Configure the SDK:

require 'whatpulse-sdk'

WhatpulseSdk.configure do |config|
  config.access_token = 'YOUR_BEARER_TOKEN'
end

Usage Example​

Fetch a user’s computers:

api_instance = WhatpulseSdk::ComputersApi.new
id = 'your_user_id_or_username'

begin
  result = api_instance.v1_users_computers(id)
  p result
rescue WhatpulseSdk::ApiError => e
  puts "Exception: #{e}"
end

API Coverage​

The SDK supports all public WhatPulse API endpoints, including users, teams, computers, and more. This SDK is automatically generated from the OpenAPI specification, ensuring it stays up-to-date with the latest API changes.

This also means that you can find all the available functions and classes on GitHub: https://github.com/whatpulse/api-sdk-ruby/

More Information​

Questions? Join our Discord or email support@whatpulse.org.