akenza-java-client

A Java client library for interacting with the akenza API.

Disclaimer: this project is under active development and APIs are not yet guaranteed to be stable.

Getting Started

Include the latest version of akenza-java-client into your project:

Maven:

<dependency>
    <groupId>io.akenza</groupId>
    <artifactId>akenza-java-client</artifactId>
    <version>0.1.0</version>
</dependency>

Start using the akenza API:

final String apiKey="";
final AkenzaAPI client=AkenzaAPI.create(apiKey);
final Workspace workspace=client.workspaces().getById("<workspaceId>").execute();

To create an api key, sign up to akenza and refer to akenza API Keys to get started.

Refer to the akenza documentation and the akenza API docs for further information.

Usage

Refer to the ./src/test directory for examples on how to use this library.

Contributing

This project uses Maven. To run the tests locally, run:

mvn clean verify

For more infos about contributing refer to CONTRIBUTING.md

License

Released under MIT by @akenza-io.

Open Points

• use Instants instead of strings for dates (Audited)
• conflicting models for asset and device
• add bulk operations
• add register/deregister actions
• check rate-limiting
• check exception handling
• add an async client
• add instrumentation
• provide an easy way of mapping entity to update command
• add support for bearer token authentication
• add rule validations in the library
• change filters to builder pattern instead of .create()
• add examples on how to use the library
• find out if okhttp shading works as it should, otherwise remove it
• add more logs
• add shortcuts for the list calls with default pagination

This library is inspired by Spotify Github Java Client and Auth0 Java Client.