TRY ME

Try Valo for free

We want to show you something amazing.

We'll send you a link to download a fully functional Valo copy to play with.



Great! Check your email and enjoy Valo



Apologies, we seem to be having a problem processing your input, please try again

Admin API

Vendors

The Vendor Api is used to register approved 3rd party vendors. The vendor list is used to approve certain actions in Valo, such as registering a bundle.

The vendor document is a free-form document with the following required fields;

  • id - the unique vendor name
  • key - the public vendor key

The document could contain additional fields, such as support and contact information.

{
  "id": "itrs",
  "key": "ef0c6be0-0904-4802-b065-73b997e6589b",
  "support": {
    "email": "support@itrsgroup.com"
  },
  "contact": {
    "address": "ITRS Group Ltd, 6th Floor, The Bonhill Building,  15 Bonhill Street, London, EC2A 4DN, UK",
    "phone": "+44 (0)20 7638 6700"
  }
}

List vendors

GET /admin/:tenant/vendors

Lists the existing vendors.

Example Request:

GET /admin/demo/vendors HTTP/1.1

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "instances": [
    "itrs"
  ]
}

Put a vendor

PUT /admin/:tenant/vendors/:id

Creates a new vendor.

Example Request:

PUT /admin/demo/vendors/itrs HTTP/1.1
Valo-Config-Version: 86a4391e-79d3-4bca-9c31-651dc38b4910

{
  "id": "itrs",
  "key": "ef0c6be0-0904-4802-b065-73b997e6589b"
}

Example Response:

Just the same as GET /admin/:tenant/vendors/:id.

Get a vendor

GET /admin/:tenant/vendors/:id

Gets an existing vendor.

Example Request:

GET /admin/demo/vendors/itrs HTTP/1.1
Valo-Config-Version: 86a4391e-79d3-4bca-9c31-651dc38b4910

{
  "id": "itrs",
  "key": "ef0c6be0-0904-4802-b065-73b997e6589b"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Valo-Config-Version: 86a4391e-79d3-4bca-9c31-651dc38b4910

{
  "id": "itrs",
  "key": "ef0c6be0-0904-4802-b065-73b997e6589b"
}

Delete a vendor

DELETE /admin/:tenant/vendors/:id

Deletes an existing vendor.

Example Request:

DELETE /admin/demo/vendors/itrs HTTP/1.1
Valo-Config-Version: 86a4391e-79d3-4bca-9c31-651dc38b4910

Example response:

HTTP/1.1 200 OK