https://github.com/lob/lob-insomnia

An Insomnia collection for authenticating and calling Lob API endpoints
https://github.com/lob/lob-insomnia

Last synced: 3 months ago
JSON representation

An Insomnia collection for authenticating and calling Lob API endpoints

• Host: GitHub
• URL: https://github.com/lob/lob-insomnia
• Owner: lob
• License: mit
• Created: 2021-08-04T21:48:29.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-13T00:27:47.000Z (over 3 years ago)
• Last Synced: 2025-01-19T07:12:16.780Z (5 months ago)
• Size: 284 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lob Insomnia

An Insomnia REST client collection for calling Lob API endpoints.

## Steps to get up and running

Follow these steps to quickly get up and running with the Lob API and Insomnia.

---

### 1. Download Insomnia Client

Visit Insomnia and download the desktop client.

> http://insomnia.rest/

---

### 2. Sign up for a Lob account

Create an account at [Lob.com](https://dashboard.lob.com/#/register).

Login to Lob dashboard and navigate to [Settings](https://dashboard.lob.com/#/settings/account).

Click on the API Keys tab. Look at your Secret and Publishable API Keys. You'll use the test\_\*. for your Test API key and live\_\*. for your Live API key.

![settings and api key](images/lob-account-settings-api-keys.png)

----

## 3. Import the Lob Insomnia collection

[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Lob%20Insomnia&uri=https%3A%2F%2Fraw.githubusercontent.com%2Flob%2Flob-insomnia%2Fmain%2Flob-insomnia-1.0.0.json)

Click Create in the Insomnia app and choose file.

Locate either `lob-insomnia-1.0.0.json` or `lob-insomnia-1.0.0.yaml` in your file system and then click Import.

---

### 4. Add your Test API key to the environment in Insomnia

Get the test API key from [Settings](https://dashboard.lob.com/#/settings/account) in Lob.

Go to the environment dropdown in Insomnia desktop and select `Manage Environments`.

![manage environment](images/manage-environment.png)

Paste your Lob Test API key as the value for `httpUsername` in your OpenAPI env and click Done.

![paste API keys in environment](images/set-api-keys-in-enviroment.png)

---

### 5. Start exploring Lob APIs

A good place to start it to `Create` one or more addresses and `List` the addresses.  Other endpoints will use the address id returned from the `List` operation.

You'll also want to `Create` one or more templates and `List` the templates prior to exploring Postcards and Self-mailers.

---

**Coming Soon**

Watch this space

_Video tutorial on setting up Insomnia_

> coming soon

_Blogpost on setting up Insomnia_

> coming soon