https://github.com/xdev-software/universe-client

A simple Java client for the Universe API
https://github.com/xdev-software/universe-client

jcon universe universe-client

Last synced: about 2 months ago
JSON representation

A simple Java client for the Universe API

• Host: GitHub
• URL: https://github.com/xdev-software/universe-client
• Owner: xdev-software
• License: apache-2.0
• Created: 2023-03-01T13:58:47.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-05-20T02:58:17.000Z (8 months ago)
• Last Synced: 2024-05-20T03:46:27.526Z (8 months ago)
• Topics: jcon, universe, universe-client
• Language: Java
• Homepage:
• Size: 639 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Latest version](https://img.shields.io/maven-central/v/software.xdev/universe-client?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/universe-client)

[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/universe-client/check-build.yml?branch=develop)](https://github.com/xdev-software/universe-client/actions/workflows/check-build.yml?query=branch%3Adevelop)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_universe-client&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_universe-client)

# Universe client for Java

A simple Java client for the [Universe API](https://developers.universe.com).

## Usage

The two basic entries are the ``ApplicationId`` and the ``RedirectUri``. They **must** be set.

If these two entries are set, you need to get ``AuthorizationCode``. This is a one-time-only code, which

you get by calling the URL provided by ``client.getUrlToGetAuthorizationCode()``.

With this ``AuthorizationCode`` you can request a ``BearerToken``. You can can request the ``BearerToken`` only 

one time with one ``AuthorizationCode``. After that the ``AuthorizationCode`` is invalidated.

This can be achieved with ``client.requestBearerToken()``.

The ``BearerToken`` can be used for all your future requests. It is usually valid for one month.

If the ``BearerToken`` is set, you can use the actual API calls.

### Example

Full example, see [Demo](universe-client-demo/src/main/java/software/xdev/Application.java).

```java

UniverseClient client = new UniverseClient(yourConfig);

// Get Events

List events = client.requestEvents(hostId);

events.forEach(event -> logger.info("Event: " + event.getTitle() + "(id:" + event.getId() + ")"));

// Get Attendees

List attendees = client.requestAttendeesInEvent(events.get(0).getId(), 5, 0);

```

## GraphQL

We are using the [Universe GraphQL API](https://developers.universe.com/docs/graphql).

Here are some thing to help with orientation with GraphQL.

You can test requests on [Universes GraphiQL (Explorer)](https://www.universe.com/graphiql);

Get Schema:

```

{

  __schema {

    queryType {

      fields {

        name

      }

    }

  }

}

```

## Installation

[Installation guide for the latest release](https://github.com/xdev-software/universe-client/releases/latest#Installation)

## Support

If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).

## Contributing

See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.

## Dependencies and Licenses

View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/universe-client/dependencies)