Usos4j

https://github.com/wms-dev/usos4j

Admin

A Java client library for the USOS API that simplifies communication with USOS institutions through...

Tokens:1,626

Snippets:34

Trust Score:8.3

License:MIT

Update:4 months ago

Show doc for...

Tokens:

Raw

### Get User Information

Source: https://github.com/wms-dev/usos4j/blob/main/spring-demo/src/main/resources/static/user.html

Retrieves user information by providing access token and token secret.

```APIDOC
## GET /userapi/user

### Description
Retrieves user information using the provided access token and token secret.

### Method
GET

### Endpoint
http://localhost:8080/userapi/user

### Parameters
#### Query Parameters
- **accessToken** (string) - Required - The access token for authentication.
- **tokenSecret** (string) - Required - The token secret for authentication.

### Response
#### Success Response (200)
- **user** (object) - Contains the user's information.
  - **id** (integer) - The user's unique identifier.
  - **username** (string) - The user's username.
  - **email** (string) - The user's email address.
```

--------------------------------

### Generic Endpoint Usage for Unauthenticated and Authenticated Requests

Source: https://github.com/wms-dev/usos4j/blob/main/README.md

Demonstrates how to use the generic endpoint of the USOS API client. The first example shows an unauthenticated request, while the second shows a request performed as a logged-in user.

```Java
var usos = Usos.builder()......build();
var serverApi = usos.getServerApi();
var usosApiRefModuleResponse = serverApi.generic()
                .request("services/apiref/module", Map.of("name", List.of("services/crstests")), UsosApiRefModule.class); // this is performed as an unauthenticated API client
var userApi = usos.getUserApi();
var userApiRefModuleResponse = userApi.generic()
                .request("services/apiref/module", Map.of("name", List.of("services/crstests")), UsosApiRefModule.class); // this is performed as a user
```

--------------------------------

### Add usos4j Dependency to Maven Project

Source: https://github.com/wms-dev/usos4j/blob/main/README.md

Include this XML snippet in your project's pom.xml to add the usos4j library as a dependency. Ensure you are using JDK 17 or higher.

```XML
<dependency>
    <groupId>pl.wmsdev</groupId>
    <artifactId>usos4j</artifactId>
    <version>1.1.4</version>
</dependency>
```

Tokens:

Raw