Skip to content

README.md

Latest commit

 

History

History
72 lines (49 loc) · 2.26 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.26 KB

Smartling Java API SDK

Java SDK for integrating with the Smartling API.

Note: Version 2.x requires Java 17+. If you need Java 8 compatibility, use version 1.x (maintenance mode).

SDK Versions

We maintain two major versions of this SDK:

Version 2.x (Current - Recommended)

  • Branch: 2.x
  • Java Compatibility: Java 17+
  • Status: Active development
  • Recommendation: All new projects should use 2.x. Existing projects are strongly encouraged to migrate.

Version 1.x (Maintenance Mode)

  • Branch: master
  • Java Compatibility: Java 8+
  • Status: Maintenance only - critical fixes and security updates
  • Future: Will be deprecated once migration to 2.x is complete

We strongly encourage all users to migrate to version 2.x to benefit from modern Java features, improved performance, and continued feature development. Version 1.x will eventually be deprecated as Smartling projects and clients complete their migration.

Using this SDK

The Smartling API SDK is distributed via Maven Central and is compatible with JDK 1.7 (Java 7) and up.

Maven

Add the SDK to your dependencies:

<dependencies>
    <dependency>
        <groupId>com.smartling.api</groupId>
        <artifactId>smartling-api-sdk</artifactId>
        <version>${version}</version>
    </dependency>
</dependency>

Gradle

Add the SDK to your dependencies:

dependencies {
    implementation "com.smartling.api:smartling-api-sdk:${version}"
}

Initialize the SDK

The Smartling SDK manages OAuth 2 authentication automatically when you provide a API v2.0 identifier and a user secret to the API factory.

SmartlingApi createSmartlingApi(String userIdentifier, String userSecret)
{
    return new SmartlingApiFactory()
        .build(userIdentifier, userSecret);
}

Contributing

Open an issue on this repository to discuss any planned changes other than bug fixes with Smartling's maintainers.

Fork this repository and create a pull request with your proposed changes. Your pull request must pass all automated tests before it will be considered for inclusion.

Smartling developers should refer to the wiki for instructions on contributing to this SDK.