lob-java

Lob

• API version: 1.3.0

The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.

Looking for our legacy Java SDK?

For more information, please visit https://support.lob.com/

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Getting Started

Registration

First, you will need to first create an account at Lob.com and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the Settings Panel.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.lob</groupId>
  <artifactId>lob-java</artifactId>
  <version>13.0.0</version>
</dependency>

Projects using the Spring framework

Some versions of the Spring framework introduce a dependency collision that prevents the Lob SDK from functioning correctly. In order to correct this, please add the following two blocks to your project's POM along with the dependency mentioned above.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.squareup.okhttp3</groupId>
            <artifactId>okhttp</artifactId>
            <version>4.9.1</version>
        </dependency>
    </dependencies>
</dependencyManagement>

and

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.9.1</version>
</dependency>

Gradle users

Add this dependency to your project's build file:

implementation "com.github.lob:lob-java:13.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/lob-java-13.0.0.jar
• target/lib/*.jar

First API Call

package com.company.app;

import com.lob.api.ApiClient;
import com.lob.api.ApiException;
import com.lob.api.Configuration;
import com.lob.api.auth.*;
import com.lob.model.*;
import com.lob.api.client.AddressesApi;

public class App
{
    public static void main( String[] args )
    {

        ApiClient lobClient = Configuration.getDefaultApiClient();

        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) lobClient.getAuthentication("basicAuth");
        basicAuth.setUsername("<YOUR_LOB_API_KEY>");

        AddressesApi apiInstance = new AddressesApi(lobClient);
        AddressEditable addressEditable = new AddressEditable();
        addressEditable.setDescription("Harry - Office");
        addressEditable.setName("Harry Zhang");
        addressEditable.setCompany("Lob");
        addressEditable.setAddressLine1("2261 Market Street");
        addressEditable.setAddressCity("San Francisco");
        addressEditable.setAddressState("CA");
        addressEditable.setAddressZip("94114");
        addressEditable.setAddressCountry(CountryExtended.US);
        addressEditable.setPhone("555-555-5555");
        addressEditable.setEmail("[email protected]");

        try {
            Address result = apiInstance.create(addressEditable);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#addressCreate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
 }

API Documentation

The full and comprehensive documentation of Lob's APIs is available here.

Testing

Unit Tests

$ mvn test "-Dtest=%regex[.*ApiTest.*]"

Integration Tests

Integration tests run against a live deployment of the Lob API and require multiple valid API keys with access to specific features. As such, it is not expected that these tests will pass for every user in every environment.

To run integration tests:

$ LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>> mvn test "-Dtest=%regex[.*SpecTest.*]"

A cleaner alternative if you are going to run integration tests frequently

Run this the first time:

$ echo "LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>>" > LOCAL.env

Then, to run the integration tests:

$ env $(cat LOCAL.env) mvn test "-Dtest=%regex[.*SpecTest.*]"

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Multithreading Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]