An open API service indexing awesome lists of open source software.

https://github.com/indix/indix-api-ruby

Ruby client for indix API
https://github.com/indix/indix-api-ruby

Last synced: 2 months ago
JSON representation

Ruby client for indix API

Awesome Lists containing this project

README

          

# indix-api-ruby
Ruby client for indix API

Installation
------------
```ruby
gem install indix-api-client
```

To load the library
-------------------
```ruby
require 'indix_api_client'
```

##Initialize Api Client
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
```

##BCS Lookup
To Get Stores
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
query = BCSQueryParams.new
query.q="nike"
ixc.get_stores(query)
```

##Product Search
To get summary products
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
query = SearchParams.new
query.q="nike"
query.countryCode="US"
query.storeId=[24]
ixc.get_summary_products(query)
```

##Product Detail
To get summary product detail
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
ixc.get_summary_product_detail("pid")
```

##Bulk Product Lookup Job
To post bulk summary product lookup
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
query = BulkProductLookupParams.new
query.countryCode="US"
query.file=File.new("---path----")
ixc.post_bulk_summary_product_lookup(query)
```

##Bulk Product Search Job
To post bulk product summary search
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
query = BulkProductSearchParams.new
query.countryCode="US"
query.storeId=[1001]
ixc.post_bulk_summary_products(query)
```

##Bulk Job Status
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
ixc.get_bulk_job_status(job_id)
```

##Bulk Job Output
```ruby
ixc = IndixApiClient.new("app_id", "app_key")
ixc.get_bulk_job_output(job_id)
```