De Bidvise-API

Bidvise heeft een REST-API voor eigen werkprocessen en koppelingen met andere systemen, tot en met een volledige veilingwebsite op de Bidvise-basis. De documentatie hieronder beschrijft sleutels, afspraken en elk beschikbaar endpoint.

API-documentatie

Basis

API-overzicht Een REST-API voor de catalogus: veilingen, sessies, kavels, items en afbeeldingen.
Authenticatie API-sleutels, wat een sleutel mag lezen, en hoe een mislukt verzoek eruitziet.
Conventies ID's, geld, paginering, expansie, fouten en versionering: de regels die elk endpoint volgt.

Resources

Veilingen & sessies Het veilingevenement en de zittingen daarbinnen: lezen, filteren en uitvouwen.
Kavels, items & afbeeldingen Wat er wordt aangeboden, het object erachter, en de foto's ervan.
Inbrengers Zoek bij een inbrengersnummer een stabiele verwijzing naar de inbrenger.
Categorieverwijzingen Zoek bestaande categorieën om een catalogusimport te koppelen.
Catalogusreferenties Categorieën, makers, bezorginstructies en biedstappen opzoeken voor een import.
Items aanmaken en bijwerken Itemgegevens, vertalingen en verwijzingen atomisch opslaan.