Quickstart

This guide creates a development application and uses its key to search the Boxpressd cigar catalog.

Prerequisites

A Boxpressd account
A server environment that can keep an API key private
curl or another HTTP client

Create a developer application

Go to developers.boxpressd.com and sign in with Boxpressd.Open My Apps, select New application, and enter an application name and description. Select at least one starter use case:

Search & discovery for catalog search and lookup
Connected Boxpressd app for OAuth user access
Data integration for server-side integrations

Click Create development app. Starter use cases recommend products and scopes. They do not restrict your application.

Create a development key

Open the application, then open Credentials. Enter a key name, choose Development, and optionally set an expiration date. Click Create API key.Copy the complete bxp_test_... value immediately. The dashboard shows it only once.

Store the key on your server

Add the key to your server environment:

BOXPRESSD_DEVELOPER_API_KEY=bxp_test_replace_me

Never place a developer key in browser JavaScript, an EXPO_PUBLIC_* or VITE_* variable, a native application bundle, or source control.

Search the catalog

Send the key in x-boxpressd-key:

curl --get "https://api.boxpressd.com/v1/cigars/search" \
  --header "x-boxpressd-key: $BOXPRESSD_DEVELOPER_API_KEY" \
  --data-urlencode "q=liga privada" \
  --data-urlencode "limit=20"

A successful response contains published cigar records and cursor pagination:

{
  "data": [
    {
      "id": "cigar_k9P4m",
      "name": "Liga Privada No. 9",
      "brandName": "Drew Estate",
      "origin": "Nicaragua",
      "wrapper": [
        {
          "region": "United States",
          "type": "Broadleaf",
          "shade": "Maduro",
          "year": null,
          "label": "Connecticut Broadleaf"
        }
      ],
      "binder": [],
      "filler": [
        {
          "region": "Nicaragua",
          "type": "Habano",
          "shade": null,
          "year": null,
          "label": "Nicaraguan Habano"
        },
        {
          "region": "Honduras",
          "type": "Corojo",
          "shade": null,
          "year": null,
          "label": "Honduran Corojo"
        }
      ]
    }
  ],
  "pagination": {
    "hasNextPage": false,
    "endCursor": null
  }
}

origin is a canonical country string. Composition fields are arrays and use [] when source data is absent. See Cigar composition before displaying or processing these fields. Next, use the official JavaScript client from ESM or CommonJS, read Authentication, try GraphQL, configure OAuth for user-specific data, or identify a cigar from a band image.

Getting started

API guides

REST reference

Prerequisites

​Prerequisites

Prerequisites