0.0
No commit activity in last 3 years
No release in over 3 years
This provides a rails client library to use the Liverail 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.4.2, ~> 0.4
>= 1.7.7, ~> 1.7
>= 1.6.7, ~> 1.6
 Project Readme

Liverail API

Purpose

This provides a gem client library to use the Liverail API.

Created by Lucas Nogueira.

Installation

edit your Gemfile

gem 'liverails_api', '~> 0.0.4'

install gem

bundle install

update gem

bundle update live-rails-api

Evironment Variables

LIVE_RAIL_USERNAME -> liverail account username
LIVE_RAIL_PASSWORD -> liverail password username
LIVE_RAIL_ENVIRONMENT-> environment that you need to use. Values: "production" to access ("http://api4.liverail.com") or "development" to access ("http://api4.int.liverail.com") 

Demo

manual authentication

require('liverails_api');
response = LiverailsApi.instance.login "username","password"
response = LiverailsApi.instance.partner_list

ENV authentication (automatic login)

export LIVE_RAIL_USERNAME=username@test.com
export LIVE_RAIL_PASSWORD=myaccountpassword
require('liverails_api');
LiverailsApi.instance.login
response = LiverailsApi.instance.partner_list

API

All endpoints exposed by http://test.api.liverail.com/

Replace the route / with _ to get your method name. like: "/partner/add" => LiverailsApi.instance.partner_add Args need to be a HASH like LiverailsApi.instance.partner_list { name:"my_partner_name" }