> For the complete documentation index, see [llms.txt](https://docs.taptap3d.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.taptap3d.com/get-started/connection-playbook.md).

# Connection playbook

Expected client setup, request syntax, iframe example and server-side rendering for the planned Taptap3D connection.

Status: proposed integration, not a released API. The examples define the intended connection syntax so a client can plan its storefront implementation. They also run against a local mock. Replace example domains only with origins issued by Binox during onboarding; no production endpoint or credential is available today.

## 1. Agree the connection settings

| Setting             | What the client needs                                                                                       |
| ------------------- | ----------------------------------------------------------------------------------------------------------- |
| `API_ORIGIN`        | Issued HTTPS origin for approved public listing data.                                                       |
| `EMBED_ORIGIN`      | Issued HTTPS origin for the frame and canonical page.                                                       |
| `PUBLICATION_ID`    | Opaque identifier of an approved publication, mapped to the storefront product.                             |
| Storefront origin   | Exact HTTPS scheme, hostname and port registered with the publication service. Register staging separately. |
| Revision policy     | Follow the latest approved revision, or pin a specific approved revision.                                   |
| Integration surface | Iframe for hosted presentation, or server-side JSON rendering for custom UI.                                |

No secret is required by the proposed public read routes. Administrative credentials must remain on a trusted server; they are not part of the client embed.

Before publishing, review the record's public fields and image rights. A private lot ID cannot stand in for `PUBLICATION_ID`. The storefront continues to own stock, prices and transactions.

## 2. Verify the public response

Proposed production request; the example domain is a placeholder:

```sh
curl --fail-with-body --get \
  'https://api.example.com/v1/publications/pub_demo_vessel' \
  --header 'Accept: application/json' \
  --data-urlencode 'locale=en' \
  --data-urlencode 'revision=rev_demo_001'
```

Remove `revision` to follow the latest approved version. Check the returned `publicationId`, `revision`, `language` and `canonicalUrl` before mapping it to a product. The full [listing contract](/proposed-reference/listing-contract.md) defines fields and errors.

## 3. Implement the chosen surface

Follow [Embed a listing](/integration-guides/iframe-guide.md) for complete host markup and validated frame messages. Follow [Render listing data](/integration-guides/data-guide.md) for the server-side JSON example. The storefront continues to own product mapping, prices, availability, checkout and payments.

Neither guide is a released platform adapter. Confirm the partner storefront permits the selected surface before committing to installation.

## 4. Exercise the expected connection

Run the [local quickstart](/get-started/local-quickstart.md). Confirm the successful fixture, pinned revision, unavailable record and withdrawn publication behave as documented. A local pass does not prove tenant isolation or production availability.

## 5. Validate before launch

Confirm actual origins, registered hosts, request quotas, withdrawal timing and support/version policy with Binox. Run the [release acceptance checks](/testing-and-support/acceptance.md), including pinned-revision withdrawal, ignored spoofed messages, browser compatibility and host-page search content.

See [Access and environments](/proposed-reference/access-and-environments.md) for current availability. For a partner integration, email <enquiry@binox.com.hk> with the target storefront and whether you need iframe or data rendering. Do not send tokens or private inventory data.


---

# 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 following URL with the `ask` and `goal` query parameters:

```
GET https://docs.taptap3d.com/get-started/connection-playbook.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.