Project

spyri-api

0.0
The project is in a healthy, maintained state
Ruby client library for the Spyri API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

>= 0
 Project Readme

SpyriApi

Ruby client library for the Spyri API

Installation

RubyGems

Just excute:

$ bundle add 'spyri-api'

Manually

Add this line to your application's Gemfile:

gem 'spyri-api'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install spyri-api

Usage

Quickstart

begin
  client = SpyriApi::Client.new
  client.set_config({
    access_token: 'YOUR_SPYRI_API_TOKEN', 
    host: 'YOUR_SPYRI_API_URL'
  })
  users_endpoint = SpyriApi::Users.new(client)
  results = users_endpoint.search(email: "toto@test.com")
  p results
rescue SpyriApi::Error => e
  puts "Error: #{e}"
end

API Documentation

You can find documentation about the Spyri API on the developers website

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/letemps-ch/spyri-api.

License

The gem is available as open source under the terms of the MIT License.