tapinomahub integration knowledge base

This is the connective layer between the OpenAPI contract and a real customer-system implementation. It explains the domain, maps goals to capabilities and operations, traces identifiers between calls, and supplies end-to-end recipes. It is intentionally usable both by developers and by coding agents with no prior automotive knowledge.

Authority rule: use the published OpenAPI contract for exact methods, paths, parameters, schemas, enum values, status codes and examples. Use the domain dictionary for canonical terminology and these guides for selection and orchestration. Do not guess facts that the public contract does not define.

Start here

Read Domain model and terminology before mapping automotive data.
Choose the right function in the Capability map or Decision guides.
Trace every ID through Identifiers and data flow.
Implement the cross-cutting rules in Runtime, errors and security.
Adapt an Integration recipe to the target system.

For connected synthetic integration cases, start with the sandbox gallery and step-by-step process guide. The catalogue links fictional vehicle and part identities to saved inputs; the process examples provide requests, expected public responses and the links between steps. Use the file inventory or test package for the saved assets. These examples describe reproducible sandbox expectations, not real-world recognition quality or fitment evidence; OpenAPI remains authoritative for the API contract.

Four knowledge layers

Layer	Question it answers	Authoritative resource
Domain knowledge	What does the automotive or account concept mean?	Domain model and domain dictionary
Product knowledge	Which tapinomahub capability should I use, and when should I not use it?	Capability map and decision guides
API knowledge	What exactly do I send and receive?	OpenAPI 3.1 JSON, API catalogue and the interactive reference
Integration knowledge	In what sequence do calls, validation, persistence and recovery happen?	Integration recipes and runtime rules

First authenticated call

The production and sandbox environments use the same base URL. The API key selects the environment and must stay in a server-side secret store.

curl --request GET \
  'https://api.tapinomahub.com/ping' \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY'

Do not paste a production key into the documentation UI, browser code, logs, support tickets or source control. The interactive reference is deliberately read-only.

Choose an entry point

I have…	I need…	Start with
A VIN	Vehicle data or vehicle-related parts	VIN decision path
An OE number	Confirmed base part information, references or a price evaluation	OE decision path
An OE number and an article to publish	An optimised eBay or marketplace listing: title, category, item specifics, keywords and shop SEO text	eBay and marketplace listing path
A vehicle registration document	Normalized document fields, a VIN, or a vehicle file	Document decision path
A parts label image	Text or part-number candidates	Label decision path
A VIN plus an OE-number cart of 1 to 30 positions	A documented vehicle-cart check	Compatibility decision path
A `tapiId`	Technical vehicle data or a listing text	Identifier flow
Images	Damage, quality, background, condition, plate, end-of-life or publication-image processing	Image decision path
An OE or aftermarket number, a `clusterId` or a VIN, and a market question	Cluster-based market intelligence or a VIN economic intelligence run; in API 1.71.0 both belong to a closed production pilot, and the VIN run is disabled	Intelligence path
Multiple customer tenants	Isolated keys, limits, usage and optional sponsorship	Client separation path

API catalogue — all operations with exact inputs, responses, errors, async and idempotency signals extracted from OpenAPI.
Domain dictionary — only terms already canonical in the released OpenAPI x-glossary.

What an integration must never infer

A path, field, enum, price, quota, timeout, storage right or retention period that is absent from the contract.
That a returned type-level fitment assignment, OE replacement, reference number, VDI code or vehicle-type candidate is a VIN-specific installation guarantee.
That an OCR or Vision result is automatically a confirmed business fact.
That a successful HTTP job-status response means the underlying job succeeded.
That a human-readable error message is stable enough for program logic.
That a missing part.name can be reconstructed from another response field. Consume the returned string or null as documented.

Contract boundaries

The knowledge base documents the tapinomahub API contract /specs/tapinoma-hub.en.json, API 1.71.0, served at https://api.tapinomahub.com. Only operations listed under that contract's paths are capabilities these guides describe. The DMS OS contract arranges a subset of the same operations by workflow and adds no path of its own; the sales-agent contract and the Commerce and Compliance previews are separate contracts that these guides do not cover.

Recommended context package for a coding agent

Give the agent these public resources together:

/machine/domain-dictionary.json
the relevant published /knowledge/ guide pages
/machine/api-catalog.json
/specs/tapinoma-hub.en.json

Then state the target system, use case, allowed endpoints, persistence constraints, tenant model and acceptance cases. Require the agent to cite an OpenAPI pointer or guide section for every tapinomahub assumption and to stop when the public contract does not define a required fact.