> For the complete documentation index, see [llms.txt](https://huh-docs.gitbook.io/challenges-add-on/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://huh-docs.gitbook.io/challenges-add-on/developer-api/api-hook-up.md).

# API Hook-up

{% hint style="info" %}
Ask for the API .jar file from [**here**](https://discord.gg/8yDm538BhU).
{% endhint %}

### Registering the API in your project

{% hint style="warning" %}
First you need to create a folder in the main path of your project and store the .jar file there.
{% endhint %}

#### Maven 

Replace `libs` with the name of the directory where the .jar file is stored and replace `API.jar` with the name of the .jar file.

{% code lineNumbers="true" %}

```atom
<dependency>
  <groupId>com.reussy.development.challenges</groupId>
  <artifactId>api</artifactId>
  <version>1.0.0-BETA</version> 
  <scope>system</scope>
  <systemPath>${project.basedir}\libs\Challenges-API.jar</systemPath>
</dependency>
```

{% endcode %}

#### Gradle

Replace `libs` with the name of the directory where the .jar file is stored and replace `API.jar` with the name of the .jar file.

```yaml
implementation fileTree(include: ['Challenges-API.jar'], dir: 'libs')
```

### Obtaining and using the API

To obtain the API class we make use of the service provided by Bukkit to register a class and retrieve it using `#getRegistration` method.

#### Retrieving the service

```java
ChallengesAPI challengesAPI = Bukkit.getServicesManager().getRegistration(ChallengesAPI.class).getProvider();
```

#### Change challenge wins

```java
UUID uuid = player.getUniqueId();
IUser user = challengesAPI.getUserUtil().getUser(uuid);
IChallenge challenge = challengesAPI.getChallengesUtil().getChallenge(@NotNull String id);
IChallengeUser challengeUser = challengesAPI.getChallengesUtil().getUserChallenge(user, challenge)

challengeUser.setChallengeWins(2);
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://huh-docs.gitbook.io/challenges-add-on/developer-api/api-hook-up.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.