Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shipengine/shipengine-java

The official Java SDK for ShipEngine API
https://github.com/shipengine/shipengine-java

address-validation api dhl-api fedex-api java jdk package-tracking rest-api sdk shipengine shipment-tracking shipping-api shipping-label shipping-rates tracking-number ups-api usps-api

Last synced: 3 months ago
JSON representation

The official Java SDK for ShipEngine API

Awesome Lists containing this project

README 

        
[![ShipEngine](https://shipengine.github.io/img/shipengine-logo-wide.png)](https://www.shipengine.com/)



ShipEngine Java SDK

===================

### The official Java SDK for ShipEngine API.

![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/ShipEngine/shipengine-java/shipengine-java%20CI/main?label=ShipEngine%20Java%20CI&logo=github)

[![Coverage Status](https://coveralls.io/repos/github/ShipEngine/shipengine-java/badge.svg?branch=main)](https://coveralls.io/github/ShipEngine/shipengine-java?branch=main)

![GitHub](https://img.shields.io/github/license/shipengine/shipengine-java?color=blue)

![OS Compatibility](https://shipengine.github.io/img/badges/os-badges.svg)



Quick Start

-----------

Install `shipengine` from the `Maven Central Repository` by adding the following under the dependencies key in your `pom.xml`:

```xml



    com.shipengine

    shipengine

    1.0.1



```



- The only configuration requirement for the SDK is providing an [API Key](https://www.shipengine.com/docs/auth/#api-keys "ShipEngine Authentication Docs").



Instantiate ShipEngine Class

----------------------------



```java

import com.shipengine.ShipEngine;



public class ShipEngineDemo {

    public static void main() {

        ShipEngine shipengine = new ShipEngine("");

    }

}

```



- You can also pass in a `HashMap/Map` containing configuration options instead of just passing in a string that is your `API Key`.



```java

import com.shipengine.ShipEngine;



public class ShipEngineDemo {

    public static void main() {

        ShipEngine shipengine = new ShipEngine(new HashMap<>() {{

            put("apiKey", "");

            put("pageSize", 75);

            put("retries", 3);

            put("timeout", 60000);

        }});

    }

}

```



Methods

-------

* [`createLabelFromRate`](./docs/create-label-from-rate-id.md) - When retrieving rates for shipments using the `getRatesWithShipmentDetails` method, the returned information contains a `rateId` property that can be used to purchase a label without having to refill in the shipment information repeatedly.

* [`createLabelFromShipmentDetails`](./docs/create-label-from-shipment-details.md) - Purchase and print a label for shipment.

* [`getRatesWithShipmentDetails`](./docs/get-rates-with-shipment-details.md) - Given some shipment details and rate options, this method returns a list of rate quotes.

* [`listCarriers`](./docs/list-carriers.md) - Returns a list of carrier accounts that have been connected through

the [ShipEngine dashboard](https://www.shipengine.com/docs/carriers/setup/).

* [`trackUsingLabelId`](./docs/track-using-label-id.md) - Track a package by its associated label ID.

* [`trackUsingCarrierCodeAndTrackingNumber`](./docs/track-using-carrier-code-and-tracking-number.md) - Track a package for a given carrier and tracking number.

* [`validateAddresses`](./docs/validate-addresses.md) - Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned.

* [`voidLabelWithLabelId`](./docs/void-label-with-label-id.md) - Void a label with its Label ID.



Contributing

------------

Contributions, enhancements, and bug-fixes are welcome!  [Open an issue](https://github.com/ShipEngine/shipengine-java/issues) on GitHub and [submit a pull request](https://github.com/ShipEngine/shipengine-java/pulls).



#### Building

To build the project locally on your computer:



1. __Clone this repo__


`git clone https://github.com/ShipEngine/shipengine-java.git`



2. __Install dependencies__


`mvn install`



3. __Build the code__


`mvn package`



4. __Lint the code__


`mvn checkstyle:check`



5. __Run the tests__


`mvn test`



VS Code Setup

-------------

Install the [Java Extension Pack](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) to help write, test and debug the application, and install [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) to enable code formatting.



Committing

----------

This project adheres to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.