LobapiSDK 1.0.0

Getting Started with Lob API

Introduction

Lob helps creators extend their applications into the physical world with automated direct mail and address verification APIs.

Get started in the way that works best for you:

• Watch our 10-minute video walkthrough showing how to get started with Lob API collections.

<video src="https://youtube.com/embed/JDrxdzqghuQ" width="340"></video>

• Explore our API documentatation: docs.lob.com

• Read through our Getting Started guide below

Need more help? Contact us at support@lob.com

Getting Started

Sign up for a free Lob account

Your API keys are located under Settings.

You'll use the SECRET API KEYS that begin with test_. for your Test API key and live_. for your Live API key.

<img src="https://s3.us-west-2.amazonaws.com/public.lob.com/assets/postman-get-api-keys.png">

In order to use the collections in this public workspace, you'll select the Lob API collection and fork it into your personal workspace.

You'll also want to setup environment variables. A short cut is to fork Lob Public Env from Lob's public workspace. You also have the option to create them yourself - see the image below.

Set the Current Value for LIVE_API_KEY and TEST_API_KEY to your Lob "live" and "test" API keys and click Save.

<img src="https://s3.us-west-2.amazonaws.com/public.lob.com/assets/postman-set-api-keys.png">

Make sure Lob Public Env is selected in the environment menu.

<img src="https://s3.us-west-2.amazonaws.com/public.lob.com/assets/postman-select-environment.png">

Start exploring Lob's API collection

The Test API key is used for all print & mail related endpoints while the Live API key is used for the address verification endpoint.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package LobapiSDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/LobapiSDK/1.0.0

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

using LobAPI.Standard;
using LobAPI.Standard.Authentication;

LobAPIClient client = new LobAPIClient.Builder()
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "username",
            "password"
        )
        .Build())
    .Environment(LobAPI.Standard.Environment.Production)
    .Build();

Authorization

This API uses the following authentication schemes.

• basic (Basic Authentication)

List of APIs

• Address Verification Intl
• Address Verification US
• Bank Accounts
• Billing Groups
• Campaign Creatives
• Campaign Uploads
• Card Orders
• Reverse Geocode
• Self Mailers
• Template Versions
• Addresses
• Campaigns
• Cards
• Checks
• Letters
• Postcards
• Templates
• Zipcode

SDK Infrastructure

Configuration

• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper