Tradenity Blog

Sat, Mar 16, 2019
  • developer
  • ruby
  • sdk
  • announcements

On behalf of the Ruby team, I ‘m happy to announce the release of the Tradenity Ruby SDK V1. This new release corresponds to the Tradenity API V1 GA containing all the new resources and updates.

The SDK Ruby API was carefully designed to make accessing the Tradenity REST API a seamless experience to Ruby programmers. It was designed to provide object oriented interface hiding all the HTTP request/response details of the REST API.

Tradenity is next generation eCommerce platform. A headless eCommerce backend that implement all the required features for a modern eCommerce solution. Exposing these functionality to developers via a simple yet powerful API. Tradenity taked eCommerce complexity out of the equation and let developers focus on innovating in their applications.


To use the Tradenity SDK, you must have:

  • Working Ruby development environment (currently v1.9.3 and v2.4.x are supported).
  • Active account in Tradenity


You can install the Ruby SDK using the standard gem tool.

gem install tradenity

Setup your credentials

First of all, you have to get API keys for your store, you can find it in your store Edit page. To get there navigate to the stores list page, click on the Edit button next to your store name, scroll down till you find the API Keys section.

Initialize the library

With the API key in hand, you can initialize the Tradenity client. Tradenity client needs the API key and an instance of AuthTokenHolder which is an object that makes Tradenity session integrates with the web framework’s session mechanism. The SDK provide implementation for Flask and Django. It’s easy to implement your own for other frameworks, It is a simple 3 method interface.

require 'Tradenity'

Tradenity.configure do |config|
  config.username = "sk_xxxxxxxxxxxxxxxxxxxxxxxxx"
  config.password = ""
  config.session_token_holder =

Make sure to replace the api keys with the ones for your store, otherwise you will get authentication error

Make your First call

The Tradenity SDK is organized into a group of model entitiy classes that corresponds to the REST API’s resources, each encapsulate the operation for a specific entity model, for example to perform operations related to the Brand resource you can use the corresponding tradenity.sdk.entities.Brand class.

Now, just call any method in your code.

@brand = Brand.find_by_id("1243-9786786-jhgjtu-789s6i")

Tutorials and sample applications

We provide 2 sample applications, actually it is the same application implemented using 2 frameworks: Rails, and Sinatra.

Camera store sample application live demo

You can find the code at github:

Camera store for rails code.

Camera store for sinatra code.

We also provide a detailed explanation of the code of these sample applications in the form of a step by step tutorials:

Camera store for rails tutorial.

Camera store for sinatra tutorial.