A thin and easy to use Java library to access the Zulip API. This library covers every API call of the Zulip REST API except for real-time events. It is aimed at being as simple as possible.
Simply build this project with mvn package and you can use the .jar in your classpath.
Just add the following dependency to your pom.xml.
<dependency>
<groupId>io.taliox</groupId>
<artifactId>zulip-java-rest</artifactId>
<version>1.0.0</version>
</dependency>You can either use a bot or a user account to communicate with the API. To find out the needed token or how to create a bot please see the official Zulip documentation.
The core of this library is the ZulipRestExecutor it is responsible for performing HTTP calls.
ZulipRestExecutor executor = new ZulipRestExecutor("user@zulip.com", "apikey","https://zulip.example.com/");To change credentials after instantiating the ZulipRestExecutor it is recommended to create a new object for the moment.
To perform an API call you should use the executeCall(ZulipRestAPICall call) method of the newly created object.
All API calls are packed inside the library as instantiatable objects which can be executed by the ZulipRestExecutor.
The naming convention of all call objects is like the following: HTTP request method + object of action.
So for instance if we want to send a message to someone on our Zulip server we need to create a PostMessage object to pass it into our executeCall method.
PostMessage postMessage = new PostMessage("anotheruser@zulip.com", "hello world");
String response = executor.executeCall(postMessage)executeCall always returns the answer from the Zulip server for instance whether the call was successful or not. After receiving the answer you can process it. Successful GET calls are often JSON encoded.
All API calls can be performed after this principle.
GetAllUsers getAllUser = new GetAllUsers();
String response = executor.executeCall(getAllUser);GetProfile getProfile = new GetProfile();
String response = executor.executeCall(getProfile);GetAllStreams getAllStreams = new GetAllStreams();
String response = executor.executeCall(getAllStreams);PostMessage postMessage = new PostMessage("anotheruser@zulip.com", "hello world");
String response = executor.executeCall(postMessage);PostMessage postMessage = new PostMessage("streamname", "topicname", "hello world");
String response = executor.executeCall(postMessage);PostCreateUser createUser = new PostCreateUser("newuser@zulip.com", "password", "the_new_longname","the_new_shortname");
String response = executor.executeCall(createUser);PostCreateStream createStream = new PostCreateStream("[{\"description\":\"This is a new stream\",\"name\":\"A new Stream\"}]");
createStream.setInvite_only(true);
createStream.setAnnounce(true);After instantiating the object to be executed you always can set optional parameters. In this case for example whether the newly created stream is supposed be invite only. This works the same for all objects.
DeleteMessage deleteMessage = new DeleteMessage("54");
String response = executor.executeCall(deleteMessage);PatchMessage patchMessage = new PatchMessage("13");
patchMessage.setContent("I edited this");
patchMessage.setType(UpdateMessageTypes.change_later);
String response = executor.executeCall(patchMessage);Please always refer to the official Zulip API documentation in case you are not sure what structure the parameters of an call object need to be. A full list of API calls, return types and parameters to perform calls can be found over there.
Thanks for your interest! Do not hesitate to open an issue if you have a question, feedback or found something that is not working like it should.
Pull requests for improvements of the library or it's documentation are also highly appreciated.
This library and its content is released under the MIT License.
The whole Zulip product and it's API can be found here. The documentation which was used here and is used inside of this project is heavily inspired by the official Zulip site and the official Zulip repositories.