README.md

groupsio-api-java

Java client library for the Groups.io API.

What is Groups.io?

Groups.io is a service that provides online communities and mailing lists - essentially a modern alternative to Yahoo! Groups.

See https://groups.io to find out more about the service.

Maven

<dependency>
    <groupId>engineer.nightowl</groupId>
    <artifactId>groupsio-api-java</artifactId>
    <version>0.0.1</version>
</dependency>

API documentation

The client is based on the API Docs. As the API is under active development and not yet considered stable, the project will be updated as soon as possible after updates are published.

GroupsIOApiClient client = new GroupsIOApiClient(apiKey, email);

Login

Use the provided password to login to Groups.io and generate an API token, which will be stored in the client instance. The token is returned should you need it.

String apiToken = client.user().login("password");

Error Handling

The client will throw GroupsIOApiException when an error is returned by the Groups.io API, or if an internal error occurs.

With the API, only invalid_value will contain an 'extra' value, all other errors just return the error type.

{
  type: "invalid_value",
  extra: "groupId"
}

Issue Reporting

If you've found an issue or have a request with this client, please create an issue.

If you have an issue or question about the API itself, a mailing list is available here.

Author

James Milligan

Legal

This project is licensed under the GPLv3 license. See the LICENSE file for more info.

The Groups.io name and logo are copyright of Groups.io, Inc, and use of the service is subject to their Terms of Service.