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

# Quickstart

> Start integrating the SignaPay API into your application in minutes

The PayHub API is a REST interface for the SignaPay PayHub platform. It covers the full merchant lifecycle — from application origination and boarding through active merchant management, reporting, and user administration. All requests are made over HTTPS.

## Prerequisites

Before you begin, make sure you have:

* A SignaPay PayHub account with API access enabled
* A long-lived **API key** issued for your client
* An HTTP client such as `curl`, Postman, or your preferred SDK

All requests must be made over HTTPS to the base URL:

```text theme={null}
https://api.payhub.com
```

***

## Step 1 — Authenticate with your API key

API keys are the only supported authentication method for API integrations.

Pass your key in every request using the `Authorization` header:

```text theme={null}
Authorization: Api-Key <your-api-key>
```

***

## Step 2 — Make your first request

With your API key in hand, try fetching the list of agents in your account:

```bash theme={null}
curl -s https://api.payhub.com/v1/crm/agents \
  -H "Authorization: Api-Key <your-api-key>"
```

A successful `200` response returns a [paginated](/api-reference/pagination) list of agent records. If the list is empty, your account may not have any agents configured yet — that's fine; the important thing is that the request authenticated successfully.

***

## Step 3 — Explore what you can do

From here, the API covers the full merchant lifecycle. Jump to the section that fits your use case:

<CardGroup cols={2}>
  <Card title="Agents" icon="briefcase" href="/api-reference/agents/overview">
    Manage sales agents, their merchant assignments, documents, and notes.
  </Card>

  <Card title="Applications" icon="user-plus" href="/api-reference/leads/overview">
    Create and board merchant applications through the full underwriting workflow.
  </Card>

  <Card title="Merchants" icon="store" href="/api-reference/merchants/overview">
    Manage active merchants, pricing schedules, equipment, and documents.
  </Card>

  <Card title="Partners" icon="handshake" href="/api-reference/partners/overview">
    Manage partner organizations, processor settings, and pricing.
  </Card>

  <Card title="Reporting" icon="chart-line" href="/api-reference/dashboards/index">
    KPI metrics and summary data for agents, merchants, and partners.
  </Card>

  <Card title="Tickets" icon="ticket" href="/api-reference/tickets/overview">
    Create and manage support tickets, activities, and document attachments.
  </Card>
</CardGroup>

***

## Next steps

* **Full API reference** — Browse every available endpoint in the [API Reference](/api-reference/overview).
* **Pagination** — All list endpoints return paged results. Learn the [request parameters and response envelope](/api-reference/pagination) before building list-fetching logic.
* **Errors** — All errors follow a consistent structure. Review [response codes and error shapes](/api-reference/errors) before building error-handling logic.
* **Board a merchant** — Ready to integrate? Follow the [end-to-end boarding walkthrough](/tutorials/boarding/merchants) from application creation through MID assignment.