Get API access

Create an API key in the Incarts dashboard before calling authenticated endpoints. Create an account or sign in, then open the API key settings for your organization. The key identifies your organization and authorizes requests for the projects and API features included with that key.

What you use

Value	Where you use it	What it controls
`projectId`	Request bodies such as `POST /v1/links`	The Incarts project that owns created shoppable links, QR codes, reporting, and future campaign records.
API key	`X-Incarts-API-Key` header	Authenticates your server.
Scopes	Attached to your API key	Allows specific actions such as creating shoppable links (`links:write`), reading links (`links:read`), or retailer-specific operations.

The API key must be allowed to access the projectId in your request. A key can be limited to selected projects or allowed across all projects in your organization. If the key is valid but does not have access to the requested project or scope, the API returns 403.

Create an API key

Create an account or sign in to the Incarts dashboard.
Open Settings > API Keys.
Create a key for your integration.
Select the project access and scopes this key should use.
Copy the API key when it is shown. Incarts only shows the full key once.
Store the key server-side and send it in the X-Incarts-API-Key header.

API key settings in the Incarts dashboard

If you do not see API Keys, ask an organization owner or administrator to create the key.

Treat API keys like passwords. Do not expose them in browser code, share them across customers, or commit them to source control.

Example access package

A Walmart-only link generation integration typically uses:

projectId: proj_abc123
apiKey: ic_live_...
scopes:
  links:write
  retailers:walmart

Use that projectId in each create-link request:

{
  "projectId": "proj_abc123",
  "name": "Summer grilling basket",
  "retailer": "walmart",
  "intent": "add_to_cart",
  "products": [
    {
      "retailerProductId": "550098461",
      "quantity": 1
    }
  ]
}

Self-serve status

Organization owners and administrators can create API keys in the dashboard. Public API endpoints for creating projects, listing projects, rotating keys, and revoking keys are not available yet.

Get started

Core workflows

In development

What you use

Create an API key

Example access package

Self-serve status

​What you use

​Create an API key

​Example access package

​Self-serve status

What you use

Create an API key

Example access package

Self-serve status