Skip to content
PHP client library for the Tradenity E-Commerce API
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/tradenity/sdk
.gitignore
CONTRIBUTING.md
HISTORY.md
LICENSE
README.md
composer.json
phpunit.xml
tradenity-php-sdk.iml

README.md

Welcome to PHP SDK for Tradenity ecommerce API

This is the official PHP SDK for Tradenity ecommerce API.

Prerequisites

To use the Tradenity SDK, you must have:

  • Working PHP development environment (currently versions > 5.5 are supported).
  • Active account in Tradenity

Installation

Installation instructions provided for composer, but the sdk is not dependent on composer, you can install using any other tool.

Add this line to your application's composer.json file:

require:{
 'tradenity/php-sdk': "1.0.1"
 }

And then execute:

$ composer install

Or install it yourself as:

$ composer install tradenity

Create store and load sample data

  • If you are not yet registered, create a new Tradenity account.
  • After you login to your account, go to Getting started page and create new store. you may click "Create sample store" to create a new store and populate it with sample data
  • From the administration side menu, choose "Developers" > "API Keys", you can use the default key or generate a new one.

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.

Usage

Initialise the library with your store api key and your framework 's SessionIdAccessor:

Tradenity\SDK\ApiClient::$ApiKey = 'sk_1234567'

Add the framework dependent SessionIdAccessor (check documentation for details):

Tradenity\SDK\ApiClient::$sessionIdAccessor = = ....

Use in your code

Invoke the required method on a specific entity, for example to get a list of all the categories for that store:

Category->find_all()

Detailed documentation can be found on our knowledge base site.

Extensions for common PHP frameworks

These libraries eases the integration between Tradenity SDK and the corresponding framework:

Laravel framework extension library.

Symphony framework extension library.

Tutorials and sample applications

We provide 2 sample applications, actually it is the same application implemented using 2 frameworks: Laravel, and Symphony. You can find live demo here:

Camera store sample application live demo

You can find the code at github:

Camera store for laravel code.

Camera store for symphony 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 laravel tutorial.

Camera store for symphony tutorial.

Contributing

  1. Fork it ( https://github.com/tradenity/php-sdk/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request
You can’t perform that action at this time.