Skip to content

Commit

Permalink
Prepare for Major Release
Browse files Browse the repository at this point in the history
  • Loading branch information
a-ibarra committed Jul 27, 2022
1 parent 412cc45 commit 38d8765
Showing 1 changed file with 29 additions and 24 deletions.
53 changes: 29 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Checkout.com Java SDK

![build-status](https://github.com/checkout/checkout-sdk-java/workflows/build-master/badge.svg)
[![GitHub license](https://img.shields.io/github/license/checkout/checkout-sdk-java.svg)](https://github.com/checkout/checkout-sdk-java/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/checkout/checkout-sdk-java.svg)](https://GitHub.com/checkout/checkout-sdk-java/releases/)
[![GitHub license](https://img.shields.io/github/license/checkout/checkout-sdk-java.svg)](https://github.com/checkout/checkout-sdk-java/blob/master/LICENSE)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=checkout_checkout-sdk-java&metric=alert_status)](https://sonarcloud.io/summary/overall?id=checkout_checkout-sdk-java)
[![OWASP-Dependency-Check](https://github.com/checkout/checkout-sdk-java/actions/workflows/dependency-check.yaml/badge.svg?branch=master)](https://github.com/checkout/checkout-sdk-java/actions/workflows/dependency-check.yaml)

<p><img src="https://i.ibb.co/6FrwfWt/Screenshot-2020-07-17-at-18-13-39.png" width="20%"></p>

> **Note** <br/>
> Version 6.0.0 is Here! <br/><br/>
> All the SDK structure was changed prioritizing NAS account systems and marking as `previous` ABC account systems <br/>
[![GitHub release](https://img.shields.io/github/release/checkout/checkout-sdk-java.svg)](https://GitHub.com/checkout/checkout-sdk-java/releases/)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.checkout/checkout-sdk-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.checkout/checkout-sdk-java/)

## Getting started

Binaries, Javadoc, and sources are all available from [Maven Central](https://search.maven.org/artifact/com.checkout/checkout-sdk-java).
> **Version 6.0.0 is here!**
> <br/><br/>
> We improved the initialization of SDK making it easier to understand the available options. <br/>
> Now `NAS` accounts are the default instance for the SDK and `ABC` structure was moved to a `previous` prefixes. <br/>
> If you have been using this SDK before, you may find the following important changes:
> * Marketplace module was moved to Accounts module, same for classes and references.
> * In most cases, IDE can help you determine from where to import, but if you’re still having issues don't hesitate to open a [ticket](https://github.com/checkout/checkout-sdk-java/issues/new/choose).
#### Gradle

Expand All @@ -33,20 +34,29 @@ dependencies {
</dependency>
```

Please check in [GitHub releases](https://github.com/checkout/checkout-sdk-java/releases) for all the versions available.
### :rocket: Please check in [GitHub releases](https://github.com/checkout/checkout-sdk-java/releases) for all the versions available.

### :book: Checkout our official documentation.

* [Official Docs (Default)](https://docs.checkout.com/)
* [Official Docs (Previous)](https://docs.checkout.com/previous)

### :books: Check out our official API documentation guide, where you can also find more usage examples.

* [API Reference (Default)](https://api-reference.checkout.com/)
* [API Reference (Previous)](https://api-reference.checkout.com/previous)

If you're having problems migrating to the new version, please create an [issue](https://github.com/checkout/checkout-sdk-java/issues/new/choose).

## How to use the SDK

This SDK can be used with two different pair of API keys provided by Checkout. However, using different API keys imply using specific API features. Please find in the table below the types of keys that can be used within this SDK.

| Account System | Public Key (example) | Secret Key (example) |
|----------------|-----------------------------------------| --------------------------------------- |
| default | pk_pkhpdtvabcf7hdgpwnbhw7r2uic | sk_m73dzypy7cf3gf5d2xr4k7sxo4e |
| previous | pk_g650ff27-7c42-4ce1-ae90-5691a188ee7b | sk_gk3517a8-3z01-45fq-b4bd-4282384b0a64 |
|----------------|-----------------------------------------|-----------------------------------------|
| Default | pk_pkhpdtvabcf7hdgpwnbhw7r2uic | sk_m73dzypy7cf3gf5d2xr4k7sxo4e |
| Previous | pk_g650ff27-7c42-4ce1-ae90-5691a188ee7b | sk_gk3517a8-3z01-45fq-b4bd-4282384b0a64 |

Note: sandbox keys have a `test_` or `sbox_` identifier, for Default and Previous accounts respectively.
Note: sandbox keys have a `sbox_` or `test_` identifier, for Default and Previous accounts respectively.

If you don't have your own API keys, you can sign up for a test account [here](https://www.checkout.com/get-test-account).

Expand Down Expand Up @@ -75,6 +85,8 @@ public static void main(String[] args) {
}
```

### Default OAuth

The SDK supports client credentials OAuth, when initialized as follows:

```java
Expand All @@ -100,7 +112,7 @@ final CompletableFuture<RefundResponse> refundPayment = client.refundPayment("pa

### Previous

If your pair of keys matches the previous system type, this is how the SDK should be used:
If your pair of keys matches the Previous type, this is how the SDK should be used:

```java
import com.checkout.previous.CheckoutApi;
Expand All @@ -126,16 +138,9 @@ public static void main(String[] args) {
All the API responses that do not fall in the 2** status codes will cause a `CheckoutApiException`. The exception encapsulates
the `requestId`, `httpStatusCode` and a map of `errorDetails`, if available.

More documentation related to Checkout API and the SDK is available at:

* [API Reference (Default)](https://api-reference.checkout.com/)
* [API Reference (Previous)](https://api-reference.checkout.com/previous)
* [Official Docs (Default)](https://www.checkout.com/docs)
* [Official Docs (Previous](https://www.checkout.com/docs/previous)

## Building from source

Once you checkout the code from GitHub, the project can be built using Gradle:
Once you check out the code from GitHub, the project can be built using Gradle:

```
gradlew build
Expand Down

0 comments on commit 38d8765

Please sign in to comment.