Documentation

REST API Integration

Alooma supports quite a few different input sources via native connections. But there are hundreds more data sources out there, with more being created all the time. One possible solution for connecting these other inputs is connecting via a REST API. For example, you can use Alooma’s REST API support to configure an input for many streaming data services.

Alooma's REST API support provides a way to connect a wide range of REST APIs that conform to a basic structure, and pull events from those endpoints directly to Alooma.

The basic procedure is to "create an Application" or some kind of credentials in the service. Then use that to add a REST API input in Alooma and configure the endpoint parameters.

Set up a REST API integration in a few simple steps:

  1. Add a new REST API input from Alooma's plumbing screen.

  2. Give your input a name. The name will appear in the plumbing screen, and will name the events that the input emits.

  3. Supply the entire URL of the API, including http:// or https://.

  4. Choose the appropriate HTTP method (GET or POST).

  5. Optionally, enter your username and password (the input only supports basic HTTP authentication).

  6. Select the pagination method that your target API requires. See Pagination for more information.

    Note

    If you leave the pagination fields blank, the pagination type will be set to None, regardless of whether a pagination type is selected.

  7. Optionally, define any parameters that the API requires passed. For each parameter, specify the Parameter name, Parameter value, and Parameter type. Parameter type can be:

    • Text - a generic parameter passed in the URL.

    • Days Past - a dynamic parameter which auto-populates with a date generated based on the number of days back from today's date. For example, if you enter "3", the API URL when called on January 5, 2017 will include the date January 2, 2017.

    Add as many parameters as you want, using the "add another parameter" option.

  8. Optionally, define the data field where the interesting return data resides in the response.

    • If the field comes back with an array of values, a separate event will be generated for each value in the array.

    • If you do not choose a field, the entire body of the response will arrive in the event.

  9. Optionally, set a Primary Key for use in consolidations. To stop your REST input from reloading data and creating duplicates, you can enable consolidations for the input by specifying a primary key. The primary key will be used as the primary key of the consolidation, and the replication index will be the event timestamp. Once a key is set, Alooma will run regular consolidations with the frequency based on the output type. See Consolidation Queries for more information.

  10. Under advanced options, you can also:

    • Optionally, define any headers that the API requires passed. Define headers just like parameters, above. You can add as many headers as you choose using the "add another header" option.

    • Choose how often you'd like Alooma to connect to the endpoint for new data (default is every 30 min). Alternatively, you can check the box and provide a cron-like definition to specify a more detailed connection schedule. Schedule Syntax

That's it! You're ready to connect your REST APIs to Alooma!

Search results

    No results found