Vtikit
Table of Contents
Vtikit is the official Ruby library for Vertilux’s API. It supports everything the API can do with simple interface written in Ruby.
Installation
Add this line to your application’s Gemfile:
gem 'vtikit'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install vtikit
Usage
You’ll need to generate an access key in Vertilux’s application. If you already have an account in Vertilux’s app you can get your key by simply visit https://erp.vertilux.com/api_key.json or run from your terminal:
curl --request GET \ --url https://erp.vertilux.com/api_key \ --header 'Content-Type: application/json' \ --user 'YOUR_EMAIL_ADDRESS'
Output
{
"first_name": "Jose",
"last_name": "Perez",
"email": "jose.perez@example.com",
"api_key": "YOUR_API_KEY",
"your_ip_addr": "127.0.0.1"
}
Resources and actions
Inventory
client.inventory.catalog client.inventory.uoms client.inventory.uom(item)
Items
client.items.list client.items.retreive(id) client.items.label(barcode)
Orders
client.orders.create()
Payload
{
"name": "Jose Perez",
"address": "7290 NW 35th Terrace , Miami, Florida 33122",
"shipvia": "Delivery",
"description": "Your order description",
"po_number": "PO666",
"line_items_attributes": [
{
"itemno": "00053900100",
"quantity": 5,
"uom": "ROLL"
},
{
"itemno": "00053900200",
"quantity": 5,
"uom": "ROLL"
}
]
}
Sales
client.sales.history
Contributing
Everyone is encouraged to help improve this project. Bug reports and pull requests are welcome at https://github.com/vertilux/vtikit/pulls. Feel free to open an issues to get feedback on your idea before spending too much time on it.
License
The gem is available as open source under the terms of the MIT License.