Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

README.md

lob-java

Maven Central Build Status Coverage Status

Java wrapper for the Lob.com API. See the full Lob.com API Documentation. For best results, be sure that you're using the latest version of the Lob API and the latest version of the java wrapper.

Table of Contents

Getting Started

Here's a general overview of the Lob services available, click through to read more.

Please read through the official API Documentation to get a complete sense of what to expect from each endpoint.

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

Include the following in your pom.xml for Maven:

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

Gradle:

compile 'com.lob:lob-java:12.0.0'

Usage

We've provided examples in the lob-java-examples/ package that has examples of how to use the lob-java wrapper with some of our core endpoints.

Initialization and Configuration

import com.lob;

Lob.init("yourApiKey");

You may optionally set an API version. This is useful for testing your code against new API versions before you upgrade.

import com.lob;

Lob.init("yourApiKey", "yourApiVersion");

API Documentation

Testing

You can run all tests with the command LOB_API_KEY=<your_test_api_key> mvn test in the main directory.

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

Copyright © 2020 Lob.com

Released under the MIT License, which can be found in the repository in LICENSE.txt.