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.
-
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.
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.
Make sure Lob Public Env is selected in the environment menu.
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
The package is compatible with Python versions 3.7+.
Install the package from PyPi using the following pip command:
pip install lob-api-sdk==1.0.0
You can also view the package at: https://pypi.python.org/pypi/lob-api-sdk/1.0.0
Test the SDK
You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:
Navigate to the root directory of the SDK and run the following commands
pip install -r test-requirements.txt
pytest
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| environment | Environment |
The API environment. Default: Environment.PRODUCTION |
| http_client_instance | HttpClient |
The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | bool |
The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | float |
The value to use for connection timeout. Default: 60 |
| max_retries | int |
The number of times to retry an endpoint call if it fails. Default: 0 |
| backoff_factor | float |
A backoff factor to apply between attempts after the second try. Default: 2 |
| retry_statuses | Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
| retry_methods | Array of string |
The http methods on which retry is to be done. Default: ['GET', 'PUT'] |
| basic_auth_credentials | BasicAuthCredentials |
The credential object for Basic Authentication |
The API client can be initialized as follows:
from lobapi.configuration import Environment
from lobapi.http.auth.basic_auth import BasicAuthCredentials
from lobapi.lobapi_client import LobapiClient
client = LobapiClient(
basic_auth_credentials=BasicAuthCredentials(
username='username',
password='password'
),
environment=Environment.PRODUCTION
)
Authorization
This API uses the following authentication schemes.
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
HTTP
Utilities
Metadata
Release files for lob-api-sdk 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| lob_api_sdk-1.0.0.tar.gz | 57.4 kB | Without provenance | Details for lob_api_sdk-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| lob_api_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for lob_api_sdk-1.0.0-py3-none-any.whl |
Total release size: 231.1 kB
Release files / lob_api_sdk-1.0.0.tar.gz
| Download URL | lob_api_sdk-1.0.0.tar.gz |
|---|---|
| Size | 57.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
befafa0ee3b74d369955094b83fafe0ba8bc975356dce0a7e34cfc7251cf1457
|
|
BLAKE2b-256 checksum How to use checksums |
77c845bb0299f3c213616b4b34b7acd4e64c3d37a33fa2cde3cad357be5cf2ac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.13
|
Release files / lob_api_sdk-1.0.0-py3-none-any.whl
| Download URL | lob_api_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 173.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1ec1a76ee790e5bd963d1940d88a5b613aebf57f3556620c2155f5173aa5b533
|
|
BLAKE2b-256 checksum How to use checksums |
d064d2f2f44a5f3b8cdbe8902e35a917c8242dc177a807f2ad3ec7076a7eb489
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.13
|
Security for lob-api-sdk 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.