https://github.com/reveldigital/reveldigital-api
Java wrapper library for the RevelDigital HTTP/JSON API.
https://github.com/reveldigital/reveldigital-api
Last synced: about 2 months ago
JSON representation
Java wrapper library for the RevelDigital HTTP/JSON API.
- Host: GitHub
- URL: https://github.com/reveldigital/reveldigital-api
- Owner: RevelDigital
- Created: 2014-06-06T21:23:46.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2018-05-17T20:42:17.000Z (about 8 years ago)
- Last Synced: 2025-01-12T01:19:58.781Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 209 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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](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:
```xml
com.reveldigital
reveldigital-api
1.4.22
```
or Gradle:
```groovy
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](http://repo1.maven.org/maven2/com/reveldigital/reveldigital-api/).
-----
# 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](http://www.reveldigital.com) for more information on RevelDigital services.
Usage typically starts with creation of a service using a service specific `Builder` instance:
```java
DeviceService service = new DeviceService.Builder()
.setApiKey("My API Key")
.build();
List devices = service.getDevices();
```
## Documentation
[https://reveldigital.github.io/reveldigital-api/javadoc/index.html](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