Skip to content

Latest commit

 

History

History
213 lines (137 loc) · 7.04 KB

README.md

File metadata and controls

213 lines (137 loc) · 7.04 KB
Raw

reloadly-java-icon

Reloadly SDK for Java

CircleCI MIT Maven Central

The Reloadly SDK for Java enables Java developers to easily work with Reloadly Services and build scalable solutions. You can get started in minutes using Maven or any build system that supports MavenCentral as an artifact source.

Getting Started

Sign up for Reloadly

Before you begin, you need a Reloadly account. Please see the Sign-Up for Reloadly section of the knowledge-base for information about how to create a Reloadly account and retrieve your Reloadly APIs credentials.

Minimum requirements

To run the SDK you will need Java 1.8+

Using the SDK Modules

The SDK is made up of several modules such as Authentication, Airtime, Giftcard etc..., you can alternatively add dependencies for the specific services you use only. For example : Authentication & Airtime (currently all modules have the same version, but this may not always be the case)

Gradle users

Add specific dependencies to your project's build file:

implementation "software.reloadly:java-sdk-authentication:1.0.2"

OR

implementation "software.reloadly:java-sdk-airtime:1.0.2"

OR

implementation "software.reloadly:java-sdk-giftcard:1.0.2"

Maven users

Add specific dependencies to your project's POM:

<dependency>
    <groupId>software.reloadly</groupId>
    <artifactId>java-sdk-authentication</artifactId>
    <version>1.0.2</version>
</dependency>

OR

<dependency>
    <groupId>software.reloadly</groupId>
    <artifactId>java-sdk-airtime</artifactId>
    <version>1.0.2</version>
</dependency>

OR

<dependency>
    <groupId>software.reloadly</groupId>
    <artifactId>java-sdk-giftcard</artifactId>
    <version>1.0.2</version>
</dependency>

Others

You'll need to manually install the following JAR :

Getting Help

GitHub issues is the preferred channel to interact with our team. Also check these community resources for getting help:

  • Checkout & search our knowledge-base
  • Talk to us live on our chat tool on our website (bottom right)
  • Ask a question on StackOverflow and tag it with reloadly-java-sdk
  • Articulate your feature request or upvote existing ones on our Issues page
  • Take a look at our YouTube series for plenty of helpful walkthroughs and tips
  • Open a case via with the Reloadly Support Center
  • If it turns out that you may have found a bug, please open an issue

Documentation

Please see the Java API docs for the most up-to-date documentation.

You can also refer to the online Javadoc.

The library uses Project Lombok. While it is not a requirement, you might want to install a plugin for your favorite IDE to facilitate development.

Running Tests

There are 3 groups of tests : integration, integration-with-proxy and all test.

  • To run all the tests, including integration tests, execute ./mvnw test. However, for integration tests to run successfully, the following environment variables are required :
export LIVE_CLIENT_ID=put_your_account_live_client_id_here
export LIVE_CLIENT_SECRET=put_your_account_live_client_secret_here
export SANDBOX_CLIENT_ID=put_your_account_sandbox_client_id_here
export SANDBOX_CLIENT_SECRET=put_your_account_sandbox_client_secret_here
export PROXY_HOST=put_your_proxy_host_here
export PROXY_USERNAME=put_your_proxy_username_here
export PROXY_PASSWORD=put_your_proxy_password_here
export PROXY_PORT=put_your_proxy_port_here

  • To run all integration tests only, execute ./mvnw test -Dgroups=integration

  • To run all proxy integration tests only, execute ./mvnw test -Dgroups=integration-with-proxy

Giving Feedback

We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels:

  • Submit issues - this is the preferred channel to interact with our team
  • Come join the Reloadly Java community chat on Slack
  • Articulate your feature request or upvote existing ones on our Issues page
  • Send feedback directly to the team at [email protected]

License

This project is licensed under the MIT license. See the LICENSE file for more info.