Skip to content

Latest commit

 

History

History
238 lines (169 loc) · 7.67 KB

SearchApi.md

File metadata and controls

238 lines (169 loc) · 7.67 KB

AliseeksApi.SearchApi

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

Method HTTP request Description
realtimeSearch POST /search/realtime Searches AliExpress in realtime
search POST /search Searches AliExpress in non-realtime. Uses the Aliseeks.com datasource which is continually updated from AliExpress.
searchBestSelling POST /search/bestSelling Retrieves best selling products from AliExpress in realtime.
searchByImage POST /search/image Searches AliExpress by image in realtime.
uploadImageByUrl POST /search/image/upload Uploads an image to AliExpress to allow it to be used in the image search endpoint

realtimeSearch

RealtimeSearchResponse realtimeSearch(realtimeSearchRequest)

Searches AliExpress in realtime

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.SearchApi();
var realtimeSearchRequest = new AliseeksApi.RealtimeSearchRequest(); // RealtimeSearchRequest | Realtime search request body 
apiInstance.realtimeSearch(realtimeSearchRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
realtimeSearchRequest RealtimeSearchRequest Realtime search request body

Return type

RealtimeSearchResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

search

SearchResponse search(searchRequest)

Searches AliExpress in non-realtime. Uses the Aliseeks.com datasource which is continually updated from AliExpress.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.SearchApi();
var searchRequest = new AliseeksApi.SearchRequest(); // SearchRequest | Search request body 
apiInstance.search(searchRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
searchRequest SearchRequest Search request body

Return type

SearchResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

searchBestSelling

BestSellingSearchResponse searchBestSelling(bestSellingSearchRequest)

Retrieves best selling products from AliExpress in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.SearchApi();
var bestSellingSearchRequest = new AliseeksApi.BestSellingSearchRequest(); // BestSellingSearchRequest | Search best selling request body 
apiInstance.searchBestSelling(bestSellingSearchRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
bestSellingSearchRequest BestSellingSearchRequest Search best selling request body

Return type

BestSellingSearchResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

searchByImage

ImageSearchResponse searchByImage(imageSearchRequest)

Searches AliExpress by image in realtime.

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.SearchApi();
var imageSearchRequest = new AliseeksApi.ImageSearchRequest(); // ImageSearchRequest | The image search request body 
apiInstance.searchByImage(imageSearchRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
imageSearchRequest ImageSearchRequest The image search request body

Return type

ImageSearchResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

uploadImageByUrl

UploadImageResponse uploadImageByUrl(uploadImageByUrlRequest)

Uploads an image to AliExpress to allow it to be used in the image search endpoint

Example

var AliseeksApi = require('aliseeks-api');
var defaultClient = AliseeksApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

var apiInstance = new AliseeksApi.SearchApi();
var uploadImageByUrlRequest = new AliseeksApi.UploadImageByUrlRequest(); // UploadImageByUrlRequest | The upload image by url request body 
apiInstance.uploadImageByUrl(uploadImageByUrlRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
uploadImageByUrlRequest UploadImageByUrlRequest The upload image by url request body

Return type

UploadImageResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json