Tradebirds offentlige HTTP-API'er versioneres i URL'en.

/api/v1

Ændringer, der bryder kompatibiliteten, kræver en ny hovedversion. Ændringer, der bevarer kompatibiliteten, kan føjes til den eksisterende version.

Kompatible ændringer

Eksempler:

• Tilføjelse af valgfrie svarfelter.
• Tilføjelse af valgfrie forespørgselsparametre.
• Tilføjelse af nye enum-værdier, når klienter skal kunne håndtere ukendte værdier.
• Tilføjelse af nye endpoints.
• Tilføjelse af nye MCP-værktøjer.

Inkompatible ændringer

Eksempler:

• Fjernelse af et svarfelt.
• Omdøbning af et svarfelt.
• Ændring af en felttype.
• Ændring af godkendelseskrav for et endpoint.
• Ændring af påkrævede anmodningsparametre.

MCP-kompatibilitet

MCP-serveren returnerer sin protokolversion under initialize. Offentlige markedspladsværktøjer er skrivebeskyttede. Værktøjernes svarformater bør være stabile nok til, at agenter kan fortolke dem, og nye felter bør behandles som tilføjelser.

Vejledning til klienter

Klienter bør:

• Ignorere ukendte felter.
• Bruge kanoniske URL'er fra svarene.
• Behandle offentlige data som kontekst til at finde muligheder, ikke som en endelig købsbeslutning.
• Holde brugerens private krav ude af offentlige API-kald, medmindre brugeren udtrykkeligt ønsker at søge med disse ord.