Skip to content

bpmsols/API-Ruby-SDK

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A Ruby SDK for accessing your Trackvia application data.

Features

  1. Simple client to access the Trackvia API

Installation

Add to your application's Gemfile:

gem 'trackvia-api-sdk'

Then execute:

bundle install

Usage

Start by trying to authenticate your user and make a simple request:

@client = Trackvia::Client.new(user_key: "abcd1234") @client.authorize('username', 'password') apps = @client.getApps

Obtain a 'user_key' by signing up at Trackvia's Developer Portal:

https://developer.trackvia.com

The client interface is more fully explained in the Ruby Docs and integration test hosted on Github.

http://rubygems.org/gems/trackvia-api-sdk

Source code:

https://github.com/Trackvia/API-Ruby-SDK

Direct link to Ruby docs:

http://rubydoc.info/gems/trackvia-api-sdk/0.0.1/frames

Logging

Client logs are stored in:

trackvia-client.log

Automatic log-file rotation occurs every 7 days.

HTTP logging is managed by rest-client, saved to a file specified by whatever file name is assigned to the environment variable, RESTCLIENT_LOG.

export RESTCLIENT_LOG=/path/to/your/logfile

About

TrackVia Ruby Kit

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages