Offentligt API

Det offentlige API er HTTP-grænsefladen bag den offentlige markedsplads. Det er versioneret under /api/v1.

Basis-URL

Angiv API'ets basis-URL én gang, og genbrug den i anmodninger:

TRADEBIRD_API_BASE_URL="https://api.tradebird.ai/api/v1"

Offentlige endpoints

Metode	Sti	Godkendelse	Formål
`GET`	`/health`	Nej	Sundhedstjek.
`GET`	`/marketplace/listings/search`	Nej	Søg i aktuelle offentlige Produkt- og Servicelister.
`GET`	`/marketplace/search/suggestions`	Nej	Foreslå typede URL'er til Kategorier, Produkter, Serviceydelser og Leverandører.
`GET`	`/marketplace/companies/{companySlug}`	Nej	Hent en køberorienteret offentlig Leverandørprofil.
`GET`	`/marketplace/companies/{companySlug}/products/{productSlug}`	Nej	Hent en offentlig Produktside fra en leverandør.
`GET`	`/marketplace/companies/{companySlug}/services/{serviceSlug}`	Nej	Hent en offentlig Serviceside fra en leverandør.
`POST`	`/marketplace/companies/{companySlug}/claims`	Nej	Start bekræftelse via domæne-e-mail for at gøre krav på en virksomhedsprofil.
`POST`	`/marketplace/company-claims/{claimId}/verify`	Ja	Bekræft et krav, og knyt profilen til et arbejdsområde.
`POST`	`/marketplace/companies/{companySlug}/removal-requests`	Nej	Start bekræftelse via officielt domæne for fuld offentlig fjernelse.
`POST`	`/marketplace/company-removal-requests/{requestId}/verify`	Nej	Bekræft og gennemfør en ikke-destruktiv offentlig fjernelse.
`GET`	`/marketplace/categories/{categorySlug}`	Nej	Hent en offentlig kategoriside.
`GET`	`/marketplace/category-roots/{rootKind}`	Nej	Vis en rodkategori for Produkter eller Serviceydelser.
`GET`	`/marketplace/categories/{rootKind}/{categorySlug}`	Nej	Hent en typet Produkt- eller Servicekategori.
`GET`	`/marketplace/articles`	Nej	Vis aktuelle offentlige Artikler.
`GET`	`/marketplace/articles/{articleSlug}`	Nej	Hent én aktuel offentlig Artikel.
`GET`	`/marketplace/market-maps`	Nej	Vis aktuelle offentlige Markedskort.
`GET`	`/marketplace/market-maps/{marketMapSlug}`	Nej	Hent ét aktuelt offentligt Markedskort.

API-reference

Åbn den interaktive Scalar-reference:

Tradebirds offentlige API-reference

Eksempel på listesøgning

curl "${TRADEBIRD_API_BASE_URL}/marketplace/listings/search?q=5-axis%20CNC&limit=5"

Svaret fra listesøgningen indeholder én relevanssorteret rækkefølge af Produkter og Serviceydelser, et nøjagtigt samlet antal, understøttede filtre, Kategori-retninger og et eventuelt nøjagtigt Leverandørmatch. Præcise Kategori-forespørgsler kan føre til en typet Kategori-URL. Produktvarianter og offentlige SKU'er fører til deres overordnede Produkt; de vises ikke som selvstændige kort.

Integrationer til at finde Produkter og Serviceydelser bruger /marketplace/listings/search.

Eksempel på virksomhedsprofil

curl "${TRADEBIRD_API_BASE_URL}/marketplace/companies/nordic-automation-demo-a-s"

Svaret indeholder én Leverandøridentitet fra den valgte version, aktuelle Produkter og Serviceydelser, begrænset dokumentation og oplysninger, relaterede Kategorier, kanoniske URL'er og privatlivssikre handlinger. Det udelader status for krav og arbejdsområde, routing til salgsagent, publicerings- og kildediagnostik, rå snapshots og rå dokumentation. Ukendte eller ikke publicerede Leverandører returnerer 404; domænebekræftede fjernede Leverandører returnerer 410.

Eksempel på krav om en virksomhed

curl -X POST "${TRADEBIRD_API_BASE_URL}/marketplace/companies/nordic-automation-demo-a-s/claims" \
  -H "Content-Type: application/json" \
  -d '{
    "requesterName": "Jane Smith",
    "requesterEmail": "jane@nordic-automation.example"
  }'

Eksempel på kategoriside

curl "${TRADEBIRD_API_BASE_URL}/marketplace/categories/industrial-automation"

Eksempel på fjernelse af en Leverandørprofil

curl -X POST "${TRADEBIRD_API_BASE_URL}/marketplace/companies/nordic-automation-demo-a-s/removal-requests" \
  -H "Content-Type: application/json" \
  -d '{
    "requesterName": "Jane Smith",
    "requesterEmail": "jane@nordic-automation-demo.example"
  }'

Fjernelse kræver kontrol over en e-mailadresse på Leverandørens aktuelle officielle domæne. Bekræftelseslinket kan bruges én gang og udløber. En gennemført bekræftelse fjerner hele den offentlige Leverandør-, Produkt-, Service-, søge-, medie-, URL-, sitemap-, API- og MCP-flade, men bevarer den kanoniske identitet og publiceringshistorik. Den gør ikke krav på Leverandøren og opretter ikke et arbejdsområde.

Eksempel på Artikel

curl "${TRADEBIRD_API_BASE_URL}/marketplace/articles/how-to-evaluate-a-cnc-machining-partner"

Detaljerede Artikelsvar indeholder den kanoniske Markdown-kilde, valgte offentlige mediemetadata, typede relationer på markedspladsen, publiceringsdatoer og sikre næste handlinger. De indeholder ikke renderet HTML eller status fra den redaktionelle proces.

Principper for svar

Offentlige svar skal være stabile og agentlæsbare. Hvor det er nyttigt, indeholder svarene kanoniske URL'er, typede relaterede begreber og udvalgt offentlig dokumentation, mens privat arbejdsområdestatus og interne publicerings- og kildemekanismer udelades.

Terminologi og kompatibilitet

Eksisterende felter og værdier som seller, sellerMatch og seller_profile henviser til leverandørvirksomheden. Navnene bevares for API- og MCP-klienter; de identificerer ikke en bestemt sælger.