> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vantr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Vantr Developer API

> Build v2 integrations with products, vendors, locations, and usage reporting.

# Developer API

<Badge icon="circle-check" color="green" stroke>v2 API</Badge>

Connect Vantr to your catalog, vendor, location, and reporting workflows with scoped credentials managed from the [developer portal](https://api.vantr.ai/developer).

<Columns cols={3}>
  <Card title="Open Developer Center" icon="layout-dashboard" href="https://api.vantr.ai/developer" cta="Open portal">
    Manage apps, credentials, scopes, usage activity, webhooks, and API-host developer workflows.
  </Card>

  <Card title="Run the quickstart" icon="rocket" href="/quickstart" cta="Start">
    Create an application, choose scopes, and make a verified read request from your server.
  </Card>

  <Card title="Explore the reference" icon="braces" href="/api-reference" cta="Open reference">
    Browse generated endpoint pages from the same OpenAPI spec that ships with this docs site.
  </Card>
</Columns>

<Info>
  Manage applications, secrets, and request activity in the API-host developer portal. Use these docs for implementation details, endpoint behavior, and generated clients.
</Info>

## First-class API host

`api.vantr.ai` is the API endpoint and the developer experience home. API-only users can use the Developer Center for docs, OAuth applications, OpenAPI, SDK starters, request activity, webhooks, and sandbox workflows without moving through the business app.

<Card title="Developer Center blueprint" icon="sparkles" href="/guides/developer-center" cta="Read the model">
  See how Vantr separates marketing, app, docs, portal, OpenAPI, sandbox, and AI discovery surfaces.
</Card>

## What you can build

<Columns cols={3}>
  <Card title="Catalog automation" icon="boxes" href="/guides/catalog-workflows" cta="Build catalog flows">
    Create and update products, variations, categories, and vendor profiles from your system of record.
  </Card>

  <Card title="Location-aware workflows" icon="map-pin" href="/api-reference/locations/list-locations" cta="List locations">
    Read tenant locations and attach valid `location_id` values to downstream workflows.
  </Card>

  <Card title="Usage visibility" icon="chart-no-axes-combined" href="/guides/usage-and-capabilities" cta="Monitor usage">
    Read API usage totals and discover the resources available to a given application.
  </Card>
</Columns>

## First useful call

Use locations as the first smoke test. The request proves authentication, tenant binding, pagination, and JSON parsing without changing data.

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -u "$CLIENT_ID:$CLIENT_SECRET" \
    "https://api.vantr.ai/v2/locations?limit=25"
  ```

  ```javascript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const credentials = Buffer
    .from(`${process.env.CLIENT_ID}:${process.env.CLIENT_SECRET}`)
    .toString('base64');

  const response = await fetch('https://api.vantr.ai/v2/locations?limit=25', {
    headers: {
      Authorization: `Basic ${credentials}`,
    },
  });

  const data = await response.json();
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import os
  import requests

  response = requests.get(
      "https://api.vantr.ai/v2/locations",
      params={"limit": 25},
      auth=(os.environ["CLIENT_ID"], os.environ["CLIENT_SECRET"]),
      timeout=20,
  )

  data = response.json()
  ```
</CodeGroup>

<Check>
  A successful locations request returns `success`, `locations`, and `pagination` fields.
</Check>

## Developer workflow

<Steps titleSize="h3">
  <Step title="Create an application" icon="square-plus">
    Create an Vantr developer application and save the client secret in your server-side secret manager.
  </Step>

  <Step title="Pick narrow scopes" icon="list-checks">
    Start with read scopes while developing. Add write scopes only for endpoints your integration calls.
  </Step>

  <Step title="Call v2 endpoints" icon="terminal">
    Use confidential client auth for server-to-server calls or exchange OAuth grants for bearer tokens.
  </Step>

  <Step title="Generate a client" icon="package-check">
    Use the committed OpenAPI file at `/openapi/v2.json` to generate typed clients for your stack.
  </Step>
</Steps>

## Guide shortcuts

<Columns cols={2}>
  <Card title="API conventions" icon="waypoints" href="/guides/api-conventions">
    Learn the base URL, auth headers, pagination parameters, and response envelope patterns.
  </Card>

  <Card title="Catalog workflows" icon="workflow" href="/guides/catalog-workflows">
    Follow product, category, and vendor examples with realistic request bodies.
  </Card>

  <Card title="Errors and recovery" icon="triangle-alert" href="/guides/errors">
    Handle OAuth errors, permission failures, validation responses, and archive conflicts.
  </Card>

  <Card title="Use with AI tools" icon="sparkles" href="/guides/ai-tools">
    Connect the docs MCP server, install the API skill, and give agents the OpenAPI contract.
  </Card>
</Columns>

## Reference shortcuts

<Columns cols={3}>
  <Card title="Products" icon="package" href="/api-reference/products/list-products">
    Product and variation catalog endpoints.
  </Card>

  <Card title="Categories" icon="folder-tree" href="/api-reference/categories/list-categories">
    Category list, tree, create, update, and archive endpoints.
  </Card>

  <Card title="Vendors" icon="building-2" href="/api-reference/vendors/list-vendors">
    Vendor profile read and write endpoints.
  </Card>
</Columns>
