Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crowdin/crowdin-api-client-java

Java client library for Crowdin API
https://github.com/crowdin/crowdin-api-client-java

api api-client client hacktoberfest java sdk

Last synced: 2 days ago
JSON representation

Java client library for Crowdin API

Host: GitHub
URL: https://github.com/crowdin/crowdin-api-client-java
Owner: crowdin
License: mit
Created: 2019-02-28T09:23:47.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-10T12:33:14.000Z (7 months ago)
Last Synced: 2024-04-10T14:54:33.005Z (7 months ago)
Topics: api, api-client, client, hacktoberfest, java, sdk
Language: Java
Homepage: https://jitpack.io/#crowdin/crowdin-api-client-java
Size: 5.3 MB
Stars: 62
Watchers: 9
Forks: 39
Open Issues: 8
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

    

    

  



# 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.



[**`API Client Docs`**](https://crowdin.github.io/crowdin-api-client-java/)  | 

[**`Crowdin API`**](https://developer.crowdin.com/api/v2/)  | 

[**`Crowdin Enterprise API`**](https://developer.crowdin.com/enterprise/api/v2/)

[![JitPack](https://img.shields.io/jitpack/v/github/crowdin/crowdin-api-client-java?cacheSeconds=3600)](https://jitpack.io/#crowdin/crowdin-api-client-java)

[![](https://jitpack.io/v/crowdin/crowdin-api-client-java/month.svg)](https://jitpack.io/#crowdin/crowdin-api-client-java)

[![](https://jitpack.io/v/crowdin/crowdin-api-client-java/week.svg)](https://jitpack.io/#crowdin/crowdin-api-client-java)

[![Tests](https://github.com/crowdin/crowdin-api-client-java/actions/workflows/basic.yml/badge.svg)](https://github.com/crowdin/crowdin-api-client-java/actions/workflows/basic.yml)

[![codecov](https://codecov.io/gh/crowdin/crowdin-api-client-java/branch/master/graph/badge.svg)](https://codecov.io/gh/crowdin/crowdin-api-client-java)

[![GitHub contributors](https://img.shields.io/github/contributors/crowdin/crowdin-api-client-java?cacheSeconds=5000)](https://github.com/crowdin/crowdin-api-client-java/graphs/contributors)

[![License](https://img.shields.io/github/license/crowdin/crowdin-api-client-java?cacheSeconds=10000)](https://github.com/crowdin/crowdin-api-client-java/blob/master/LICENSE)



## Installation

### Gradle

```groovy

repositories {

    maven { url "https://jitpack.io" }

}

dependencies {

    compile "com.github.crowdin:crowdin-api-client-java:1.19.2"

}

```

### Maven

```xml

    

        jitpack.io

        https://jitpack.io

    

    com.github.crowdin

    crowdin-api-client-java

    1.19.2

```

## 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.