APIHub

Installation

Add this line to your application's Gemfile:

gem 'apihub'

And then execute:

$ bundle

Or install it yourself as:

$ gem install apihub

Usage

First authorize requests by setting the API key found on your account's settings page.

APIHub.api_key = ENV['APIHUB_KEY']

Then you can lookup people by email address:

person = APIHub::Person[email: '[email protected]']

If the person can't be found, then nil will be returned.

See the documentation for more information.

Company lookup

You can lookup company data by domain name:

company = APIHub::Company[domain: 'uber.com']

If the company can't be found, then nil will be returned.

See the documentation for more information.

Streaming requests

Often you'll want people or company lookups to block, rather than return blank 202 requests if we need to look up data. You can do this using APIHub's streaming API.

For example, to look up a company by domain using our streaming API use the APIHub::Streaming::Company class:

company = APIHub::Streaming::Company[domain: 'uber.com']

If we need to lookup the company, we'll block the network request for 10-20 seconds before responding. This is ideal for scenarios where long network requests don't really matter, such as job queues. Often the streaming API will be easier to implement than webhooks.

You can similarity look up people using the APIHub::Streaming::Person class.

person = APIHub::Streaming::Person[email: '[email protected]']

CLI

The gem also includes a apihub executable, which you can use like this:

$ apihub person --email [email protected]

    {
      "name": {
        "fullName": "Alex MacCaw",
        "givenName": "Alex",
        "familyName": "MacCaw"
      },
      ...

Or to look up a company:

$ apihub company --domain uber.com

    {
      "name": "Uber",
      "legalName": "Uber, Inc.",
      "categories": [
        "Transport"
      ],
      "founders": [
        "Travis Kalanick",
        "Garrett Camp"
      ],
      ...