API Reference

We have set up a little demo Java client for you to kick off development.

👉 Download the Java demo client

The java sample uses JDK 1.8 and Maven (but it can also be rebuilt with a newer JDK and gradle). In order to run the sample, first you need to install the jdk and setup paths so that java and maven are available.

Build the app:

Open a command prompt window in the app folder and run maven:

c:\...\app> mvn package

After successful build, run the app.
Similar to the C# example, it requires two command-line parameters, first is the url to the API server and the second is the api key.

c:\...\app> cd target
c:\...\app\target> java -jar app-1.0.fat.jar https://api.pickup.bd.com your-api-key

If everything is ok, you should see the message

"connected. press enter to disconnect."

681

Java sample screenshot

If you call the Web API with the same api key, you should see a notification in the terminal window.