aliseeks_api

AliseeksApi - the Ruby gem for the Aliseeks API

AliExpress product searching and product details retrieval API.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.4
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build aliseeks_api.gemspec

Then either install the gem locally:

gem install ./aliseeks_api-1.0.4.gem

(for development, run gem install --dev ./aliseeks_api-1.0.4.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'aliseeks_api', '~> 1.0.4'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/aliseeks/connect-ruby-sdk, then add the following in the Gemfile:

gem 'aliseeks_api', :git => 'https://github.com/aliseeks/connect-ruby-sdk.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'aliseeks_api'

# Setup authorization
AliseeksApi.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
end

api_instance = AliseeksApi::ProductsApi.new
opts = {
  product_request: AliseeksApi::ProductRequest.new # ProductRequest | The request body of get product 
}

begin
  #Get products details as an aggregated request from AliExpress in realtime. 
  result = api_instance.get_product(opts)
  p result
rescue AliseeksApi::ApiError => e
  puts "Exception when calling ProductsApi->get_product: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.aliseeks.com/v1

Class	Method	HTTP request	Description
AliseeksApi::ProductsApi	get_product	POST /products	Get products details as an aggregated request from AliExpress in realtime.
AliseeksApi::ProductsApi	get_product_details	POST /products/details	Gets product details from AliExpress in realtime.
AliseeksApi::ProductsApi	get_product_html_description	POST /products/description/html	Get product HTML description from AliExpress in realtime.
AliseeksApi::ProductsApi	get_product_reviews	POST /products/reviews	Get product reviews from AliExpress in realtime
AliseeksApi::ProductsApi	get_product_shipping	POST /products/shipping	Gets product shipping information AliExpress in realtime.
AliseeksApi::ProductsApi	get_product_skus	POST /products/variations	Gets product skus / variation information from AliExpress in realtime.
AliseeksApi::SearchApi	realtime_search	POST /search/realtime	Searches AliExpress in realtime
AliseeksApi::SearchApi	search	POST /search	Searches AliExpress in non-realtime. Uses the Aliseeks.com datasource which is continually updated from AliExpress.
AliseeksApi::SearchApi	search_best_selling	POST /search/bestSelling	Retrieves best selling products from AliExpress in realtime.
AliseeksApi::SearchApi	search_by_image	POST /search/image	Searches AliExpress by image in realtime.
AliseeksApi::SearchApi	upload_image_by_url	POST /search/image/upload	Uploads an image to AliExpress to allow it to be used in the image search endpoint

Documentation for Models

• AliseeksApi::Amount
• AliseeksApi::BestSellingSearchItem
• AliseeksApi::BestSellingSearchRequest
• AliseeksApi::BestSellingSearchResponse
• AliseeksApi::DoubleRange
• AliseeksApi::ImageSearchCategory
• AliseeksApi::ImageSearchItem
• AliseeksApi::ImageSearchRequest
• AliseeksApi::ImageSearchResponse
• AliseeksApi::IntegerRange
• AliseeksApi::NonRealtimeCurrency
• AliseeksApi::PriceRange
• AliseeksApi::PriceSummary
• AliseeksApi::Product
• AliseeksApi::ProductAttribute
• AliseeksApi::ProductBulkOption
• AliseeksApi::ProductDetail
• AliseeksApi::ProductDetailsRequest
• AliseeksApi::ProductHtmlDescription
• AliseeksApi::ProductHtmlDescriptionRequest
• AliseeksApi::ProductPriceOption
• AliseeksApi::ProductPromotion
• AliseeksApi::ProductPropertyVariationIdentifier
• AliseeksApi::ProductRequest
• AliseeksApi::ProductRequestComponent
• AliseeksApi::ProductReview
• AliseeksApi::ProductReviews
• AliseeksApi::ProductReviewsRequest
• AliseeksApi::ProductSeller
• AliseeksApi::ProductShipping
• AliseeksApi::ProductShippingOptions
• AliseeksApi::ProductShippingRequest
• AliseeksApi::ProductSku
• AliseeksApi::ProductSkus
• AliseeksApi::ProductSkusRequest
• AliseeksApi::PromotionOption
• AliseeksApi::RealtimeCurrency
• AliseeksApi::RealtimeSearchAggregation
• AliseeksApi::RealtimeSearchItem
• AliseeksApi::RealtimeSearchRequest
• AliseeksApi::RealtimeSearchResponse
• AliseeksApi::SearchAggregation
• AliseeksApi::SearchItem
• AliseeksApi::SearchItemFreight
• AliseeksApi::SearchItemFreightType
• AliseeksApi::SearchItemSeller
• AliseeksApi::SearchPriceOption
• AliseeksApi::SearchRequest
• AliseeksApi::SearchResponse
• AliseeksApi::SkuPriceOption
• AliseeksApi::SkuPriceOptionProperty
• AliseeksApi::SkuProperty
• AliseeksApi::SkuPropertyValue
• AliseeksApi::StringRange
• AliseeksApi::TimeDuration
• AliseeksApi::TradeInformation
• AliseeksApi::UploadImageByUrlRequest
• AliseeksApi::UploadImageResponse
• AliseeksApi::WebError

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-CLIENT-ID
• Location: HTTP header