Following links

Resources returned by the Partner API include a Links array describing what you can do next with that resource, and where the related data lives. This follows the HATEOAS principle: the response tells you what is available rather than requiring you to construct URLs yourself.

Each entry has four properties:

Example

{
  "OrderId": "fc4c2871-90a6-f111-ab47-0642df0a324c",
  "Links": [
    {
      "Rel": "self",
      "Href": "https://partnerapi.nowinfinity-test.com.au/v1.0/documents/fc4c2871-90a6-f111-ab47-0642df0a324c",
      "Action": "GET",
      "MediaType": "application/json"
    },
    {
      "Rel": "files",
      "Href": "https://partnerapi.nowinfinity-test.com.au/v1.0/documents/fc4c2871-90a6-f111-ab47-0642df0a324c/files",
      "Action": "GET",
      "MediaType": "application/json"
    },
    {
      "Rel": "document-webpage",
      "Href": "https://tornado.nowinfinity-test.com.au/#/documents/fc4c2871-90a6-f111-ab47-0642df0a324c/collaboration",
      "Action": "GET",
      "MediaType": "text/html"
    }
  ]
}

API links (MediaType: application/json) point at other Partner API endpoints — the resource itself, its related form, its generated files.

Web links (MediaType: text/html) point at the NowInfinity platform UI. These are for opening the record in a browser, not for calling programmatically. They are useful if your product offers customers a "view in NowInfinity" action.

Check MediaType before doing anything with a link. Sending a Bearer token to a web page will not do what you want.

Prefer following a link over building the URL yourself. Constructing /v1/documents/{id}/files by hand works today, but a link that came back with the resource is correct by definition.

1. Create a form           → response includes Links
2. Find Rel: "self"        → the document
3. POST to /forms/process  → generation starts
4. Find Rel: "files"       → poll until the files are ready

Match on Rel, not array position. The set of links returned varies by resource type and state, and the order is not guaranteed.

• API structure — endpoints and status codes.
• Error codes — handling failures.