# Crowdin Java client
The Crowdin Java client is a lightweight interface to the Crowdin API that works in any Java environment. It provides common services for making API requests.
Our API is a full-featured RESTful API that helps you to integrate localization into your development process. The endpoints that we use allow you to easily make calls to retrieve information and to execute actions needed.
## Installation
### Gradle
```groovy
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
compile "com.github.crowdin:crowdin-api-client-java:1.17.1"
}
```
### Maven
```xml
jitpack.iohttps://jitpack.iocom.github.crowdincrowdin-api-client-java1.17.1
```
## Quick Start
```java
import com.crowdin.client.Client;
import com.crowdin.client.core.model.Credentials;
public class ListProjectBranchesExample {
public static void main(String[] args) {
Credentials credentials = new Credentials("token", "organization");
Client client = new Client(credentials);
client
.getSourceFilesApi()
.listBranches(123L, null, 500, null)
.getData()
.forEach(branch -> System.out.println(branch.getData()));
}
}
```
### Customization
This client uses [Apache http client](https://hc.apache.org/) and [Jackson json library](https://github.com/FasterXML/jackson).
Usage of these libraries is wrapped into interfaces and gives possibility to override them and use different libraries for http communication or json transformations.
The library entry point is `com.crowdin.client.Client` and this class has additional constructor where you can specify additional configurations (please refer to javadoc).
#### Http timeouts
Library allows you to configure http requests timeout.
```java
import com.crowdin.client.Client;
import com.crowdin.client.core.model.ClientConfig;
import com.crowdin.client.core.model.Credentials;
public class Main {
public static void main(String[] args) {
Credentials credentials = new Credentials("token", "organization");
Client client = new Client(credentials, ClientConfig.builder().httpTimeoutMs(5000).build());
}
}
```
## Seeking Assistance
If you find any problems or would like to suggest a feature, please read the [How can I contribute](/CONTRIBUTING.md#how-can-i-contribute) section in our contributing guidelines.
## Contributing
If you would like to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.
## License
The Crowdin Java client is licensed under the MIT License.
See the LICENSE file distributed with this work for additional
information regarding copyright ownership.
Except as contained in the LICENSE file, the name(s) of the above copyright
holders shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written authorization.
