lob-java

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
  • Registration
  • Installation
  • Usage
• Examples
• API Documentation
• Contributing
• Testing

Getting Started

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

• Postcards API
• Letters API
• Checks API
• Address Verification API

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

• Introduction
• Versioning
• Errors
• Rate Limiting
• Webhooks
• Cancellation Windows
• Scheduled Mailings
• Metadata
• HTML Templates
• Asset URLs
• Addresses
  • Address Book
    • The Address Object
    • Create an Address
    • Retrieve an Address
    • Delete an Address
    • List all Addresses
• US Verification API
  • US Verification API
    • The US Verification Object
    • Verify a US Address
  • US Autocompletion API
    • The US Autocompletion Object
    • Autocomplete a US Address
    • The US Autocompletion Test Environment
• Int'l Verification API
  • International Verifications
    • Verify an International Address
• Postcards API
  • Postcards
    • The Postcard Object
    • Create a Postcard
    • Retrieve a Postcard
    • Cancel a Postcard
    • List all Postcards
• Letters API
  • Letters
    • The Letter Object
    • Create a Letter
    • Retrieve a Letter
    • Cancel a Letter
    • List all Letters
• Checks API
  • Checks
    • The Check Object
    • Create a Check
    • Retrieve a Check
    • Cancel a Check
    • List all Checks
  • Bank Accounts
    • The Bank Account Object
    • Create a Bank Account
    • Retrieve a Bank Account
    • Delete a Bank Account
    • Verify a Bank Account
    • List all Bank Accounts
• Resources
  • Countries
    • List all Countries
  • States
    • List all States
• Appendix
  • API Changelog
  • The Tracking Event Object
  • Events
  • HTML Examples
  • Image Prepping
  • US Verification Details

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.