This post is now outdated, please view the updated one about the newly released major version 1.0.
On behalf of the Ruby team, I ‘m happy to announce the initial release of the Tradenity Ruby SDK. 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.
To use the Tradenity SDK, you must have:
You can install the Ruby SDK using the standard
gem install tradenity
First of all, you have to get API keys for your store, you can find it in your store
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.
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.api_key = 'sk_1234567'
Make sure to replace the api keys with the ones for your store, otherwise you will get authentication error
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
Now, just call any method in your code.
@brand = Brand.find_by_id("1243-9786786-jhgjtu-789s6i")
We provide 2 sample applications, actually it is the same application implemented using 2 frameworks:
You can find the code at github:
We also provide a detailed explanation of the code of these sample applications in the form of a step by step tutorials: