Getting Started
Start here.
The VU.CITY Build API is our HTTP API for working with VU.CITY data from your own systems. Use it to pull platform data into your existing tools and workflows, or to bring your own data into VU.CITY, rather than working through the VU.CITY applications by hand.
Closed alpha
The Build API is currently in a closed alpha. It isn't generally available - we're rolling it out to a limited set of customers while it's still taking shape.
Talk to your account manager
If you're interested in access, speak to your VU.CITY account manager. They can tell you whether the API is a fit for what you're trying to do, but access during the closed alpha isn't guaranteed.
Get a client app
The Build API authenticates each caller as a client app, not as an individual user. If you've been given access, your account manager will arrange for a client app to be set up, and for a client ID and client secret to be issued to you - there's no self-service way to create one yet.
Once you have those, head to Authentication to exchange them for an access token and make your first request.
This API is at v0
The Build API is currently versioned v0, which marks it as experimental: breaking changes to request/response shapes, scopes, and behaviour are expected while we finish shaping it, and nothing under v0 should be treated as stable.
A v1 release is planned, and will be the stable version we'd recommend building a long-term integration against. Until then, keep in mind that:
v0endpoints can change or be removed without the usual deprecation notice.- Your integration should be able to tolerate updates, and it's worth checking this documentation before upgrading anything that talks to the API.
- When
v1ships,v0will move to a deprecated state with a sunset date, rather than disappearing immediately - see the API reference for details on any given endpoint.
Next steps
- Authentication - get an access token and make an authenticated request.
- API reference - browse the available endpoints.