Getting Started with Lob

Introduction

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.

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install my-package-sdkwewqe==4.5.5

You can also view the package at: https://pypi.python.org/pypi/my-package-sdkwewqe/4.5.5

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:

The API client can be initialized as follows:

client = LobClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='BasicAuthUserName',
        password='BasicAuthPassword'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

• basicAuth (Basic Authentication)

List of APIs

• Bank Accounts
• Billing Groups
• Buckslip Orders
• Card Orders
• Identity Validation
• Intl Autocompletions
• Intl Verifications
• QR Codes
• Reverse Geocode Lookups
• Self Mailers
• Template Versions
• URL Shortener
• US Autocompletions
• US Verifications
• Zip Lookups
• Addresses
• Buckslips
• Campaigns
• Cards
• Checks
• Creatives
• Letters
• Postcards
• Templates
• Uploads

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest