Skip to content
This repository was archived by the owner on Mar 8, 2019. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@ Otherwise it will use `multi_json`'s bundled json parser.
## Basic usage

The gem has been implemented with the idea that requests can be done in
parallel using [Typhoeus](https://github.com/dbalatero/typhoeus).
parallel using [Typhoeus](https://github.com/typhoeus/typhoeus).

First the API key and base URL need to be configured properly:

Amiando.base_url = 'https://www.amiando.com'
Amiando.api_key = 'your API key'

To get API key use this [link](http://developers.amiando.com/index.php/How_to_get_your_API_key).

You can query multiple requests and run then like this:

Expand All @@ -40,6 +47,17 @@ All attributes should be used in snake_case format instead of the CamelCase
used in the official documentation. For example, for a user, you should call
first_name instead of firstName.

### Pro-Tips

In case of such error when you try to run tests:

webmock-1.7.10/lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb:167:in `alias_method': undefined method `queue' for class `Typhoeus::Hydra' (NameError)

probably you need to install:

libcurl


## Documentation

The full amiando API isn't fully implemented yet, however you can find here the
Expand Down