This is a Java client SDK for the Koofr service API. See the examples folder for a quick start.
import net.koofr.api.auth.Authenticator;
import net.koofr.api.auth.basic.HttpBasicAuthenticator;
import net.koofr.api.http.Client;
import net.koofr.api.rest.v2.Api;
public class Main {
public static void main(String args[]) {
Client c = new BasicClient();
Authenticator a = new HttpBasicAuthenticator("username", "password");
Api api = new Api("https://app.koofr.net/api/v2", a, c);
Self self = api.self().get();
}
}Obviously, you need an HTTP Client and an Authenticator to use the Api.
The SDK provides an abstraction for both. You probably won't need to implement your
own authenticator since the ones supplied in net.koofr.api.auth subpackages cover all
possible authentication options you have with Koofr: OAuth2, HTTP Basic and our own
authentication token scheme.
You might want to implement your own HTTP client on the other hand: we provide a simple one
based on the HttpURLConnection class from the Java runtime, but you might want to use an
Apache HttpComponents based one or whatever the preferred option on your platform is.
You're welcome, you just need to implement the Client, Request and Response interfaces.
There are two examples demonstrating use of a Koofr client. Run them via Gradle:
./gradlew :examples:info:run --args='app.koofr.net myemail@example.com my_app_password'
or
./gradlew :examples:cmdline:run --args='app.koofr.net myemail@example.com my_app_password'
Note that HTTP Basic authentication on app.koofr.net as used by above examples requires you to
generate a limited-scope application password for your Koofr account in our webapp, at
https://app.koofr.net/app/admin/preferences/password
The hostname is passed in without protocol and without any slashes.
You can also use OAuth2-based authentication in the examples, by replacing the username and password with token URL, client ID, client secret and grant code. However, you need to get the grant code before running the examples: perhaps with curl or with OAuth Playground
To build jars use
./gradlew build
Packaged versions are available in our Maven repository at
https://repo.koofr.eu/maven with group ID koofr.net and
artefact ID java-koofr.
For Gradle, you will want to use the following repository:
repositories {
maven {
url = uri("https://repo.koofr.eu/maven")
}
}
And declare your dependency with
dependencies {
implementation 'net.koofr:java-koofr:3.8.0'
}