> For the complete documentation index, see [llms.txt](https://docs.unimarket.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.unimarket.com/documentation/rest-api-nova-public-api/rest-api-introduction.md).

# REST API Introduction

The **Nova Public API** is a RESTful web API that lets external applications query Unimarket data directly over HTTP, using standard methods like `GET`, `POST`, `PATCH`, and `DELETE`. It's the option to reach for when you need on-demand, programmatic access to Unimarket data rather than batch files or transactional message flows.

## When to Use the REST API

* **On-demand lookups**: Querying supplier records, contacts, or remittance addresses from an external application in real time.
* **Custom integrations**: Building bespoke tooling or dashboards that need direct, authenticated access to Unimarket data.
* **Complementing other integrations**: Used alongside cXML transactions, sFTP file automation, or middleware connectors where a synchronous data pull is needed.

## How It Compares to Other Integration Options

| Option                               | Best For                                                |
| ------------------------------------ | ------------------------------------------------------- |
| **REST API**                         | Real-time, on-demand data access via HTTP requests      |
| **Transactions (cXML/OrderRequest)** | High-volume order, invoice, and change order automation |
| **File Automation (sFTP)**           | Scheduled batch uploads/downloads of master data        |
| **Integration Middleware (Workato)** | No-code/low-code connector-based integrations           |

## Getting Started

The REST API is available across AU, NZ, US, and DEMO tenants, and requires a bearer token for authentication.

For full endpoint documentation, authentication details, error codes, pagination, and object schemas, see the [**API Reference**](https://github.com/Unimarket/nova-public-api-docs/tree/gitbook-sync/api-reference/README.md) section of this site.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.unimarket.com/documentation/rest-api-nova-public-api/rest-api-introduction.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.