{"id":1928,"date":"2017-01-27T08:40:03","date_gmt":"2017-01-27T08:40:03","guid":{"rendered":"https:\/\/www.botreetechnologies.com\/blog\/?p=1928"},"modified":"2021-01-08T15:14:22","modified_gmt":"2021-01-08T09:44:22","slug":"omnivore-api-ruby-rails","status":"publish","type":"post","link":"https:\/\/www.botreetechnologies.com\/blog\/omnivore-api-ruby-rails\/","title":{"rendered":"Installing Omnivore API in Ruby on Rails Application"},"content":{"rendered":"\n

Omnivore API provides the universal Point of Sale (POS) API. It gives you access to every action and detail of the point of sale system in a restaurant. This includes menu information, orders, payments, tips, server and table information and historical sales data. You can find more details on omnivore here.<\/a><\/p>\n\n\n\n

Omnivore’s cloud-based development platform<\/a> enables a single integration through our API, seamlessly facilitating the connections to POS systems now and into the future. By lowering the technology integration<\/a> barriers for app developers, Omnivore simplifies the process for restaurants to test and evaluate new technologies through a proven interface installed on their POS.<\/p>\n\n\n\n

\"Omnivore<\/figure>\n\n\n\n

Setup Omnivore App<\/h2>\n\n\n\n

You can register on Omnivore using your Github account or by providing email address and other details. so let’s first create an account. Click here<\/a> to register.<\/p>\n\n\n\n

Once you get registered, you can see screen similar to below.<\/p>\n\n\n\n

\"omnivore<\/figure>\n\n\n\n

Click on the Applications link from the menu and you will find one demo application ready for use. You can also create your own application here. Inside API tools, you can trace your API activity with POS and you can test your requests and response on API console.<\/p>\n\n\n\n

Here we are going to use this Virtual POS location. We have to use the location ID in each request, so note it down first. Now let’s move to the API console. You can simulate all requests mentioned here<\/a> in your API console. It will respond based on the current virtual POS data.<\/p>\n\n\n\n

Go to your demo application and note down the API key. You can find it at applications > API keys > [Your development API key]<\/b>. We will use default development key here.<\/p>\n\n\n\n

\"api<\/figure>\n\n\n\n

As you can see it provides different API key for accessing different version API so make sure that you are using the correct version of API key with that version of API.<\/i><\/p>\n\n\n\n

Now, we have our account on Omnivore and an application with API key so let’s move to the Rails part.<\/p>\n\n\n\n

Integrate with Rails App<\/h3>\n\n\n\n

Create a new Rails application<\/a> first. We are going to access Omnivore API through HTTP requests so we need to add gem HTTParty.<\/p>\n\n\n\n

Add below line to your gemfile and do bundle install.<\/p>\n\n\n\n

gem 'httparty'<\/code><\/p><\/blockquote>\n\n\n\n

To enable bootstrap css, you can also add bootstrap-sass<\/b> gem in it.<\/p>\n\n\n\n

First of all, we will display all the available items to user so that one can choose and buy. We will restrict the user to buy only one item at a time for this demo version but you can implement a cart and do same.<\/p>\n\n\n\n

Now, create a tickets controller and an action to fetch all the items and display them. Before that, let’s create a base_url method so that we don’t need to write base URL every time on the HTTP call.<\/p>\n\n\n\n