Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.75 KB

README.md

File metadata and controls

66 lines (43 loc) · 1.75 KB
Raw

reveldigital-api

Java wrapper library for the RevelDigital HTTP/JSON API. Documentation for the REST API can be found at the developers website http://developer.reveldigital.com.

Access to the API requires an API key which is generated per RevelDigital account.

Get it!

Maven

Functionality of this package is contained in Java package com.reveldigital.

To use the package, you need to use following Maven dependency:

<dependency>
  <groupId>com.reveldigital</groupId>
  <artifactId>reveldigital-api</artifactId>
  <version>1.4.22</version>
</dependency>

or Gradle:

compile 'com.reveldigital:reveldigital-api:1.4.22'

or download jars from Maven repository.

Non-Maven

For non-Maven use cases, you download jars from Central Maven repository.

Use it!

General

Usage requires an API key. To obtain a key you must have a RevelDigital account. API keys are generated by the user on the Account > Account Information page.

Please see http://www.reveldigital.com for more information on RevelDigital services.

Usage typically starts with creation of a service using a service specific Builder instance:

DeviceService service = new DeviceService.Builder()
                .setApiKey("My API Key")
                .build();
List<Device> devices = service.getDevices();

Documentation

https://reveldigital.github.io/reveldigital-api/javadoc/index.html

License

Copyright (c) 2016 Mike Tinnes

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0