@geeny/application-broker

Geeny Application Broker API Node.js Client

The Application Broker API is used for connecting applications to the Geeny platform and accessing data from connected data sources via message streams.

• API Reference
• Onboarding: Step 3: Access device data via Geeny API

Introduction

Everything what you need before starting to use this is to setup application on the Geeny platform. Follow the instruction Step 1: Set up application on the Geeny platform if you haven't done it yet.

Installation

// install as a global package
$ npm i -g @geeny/application-broker

// install and save as a local package
$ npm i @geeny/application-broker

Usage

Initializing

const appBroker = require('@geeny/application-broker')

const apiClient = appBroker(
  '<your_application_id>',
  '<your_jwt_token>',
  '<geeny_base_url>' // optional parameter (default: https://developers.geeny.io/ab/subscribe)
)

API

The library provides four public async methods:

• getShards(messageType: string)
• createShardIterator(messageType: string, shardId: string, iteratorType: string = 'EARLIEST', maxBatchSize: number = 500, startingSequenceNumber: string = null)
• getMessageData(messageType: string, iteratorId: string)
• createCheckpoint(messageType: string, ...checkpoints: {shardId: string, sequenceNumber: string})

Examples

See the /examples folder for sample how to use library. You can run example by the following command (make sure you've run npm install before):

$ APP_ID=<your_app_id> TOKEN=<your_jwt_token> MESSAGE_TYPE=<message_type> node examples/index.js

Or directly change configuration in the file examples/index.js and simply run node examples/index.js.

Debugging

Launch the node process like NODE_DEBUG=request node script.js

License

Copyright (C) 2018 Telefónica Germany Next GmbH, Charlottenstrasse 4, 10969 Berlin.

This project is licensed under the terms of the Mozilla Public License Version 2.0.