How-to

Make your first request

Sign in, create an Application and an API Key, and call the VIS API.

This guide takes you from signing in to the Developer Portal to your first successful request to the VIS API.

Sign in

Select Sign in on the Developer Portal home page and sign in with your FIVB account. On your first sign-in, the portal creates your Personal Team: an Organization that only you belong to.

Create an Application

  1. Open Applications and select New Application.
  2. Enter a name and, if you want, a description of what the Application does with the VIS API.
  3. Select Create Application.

The Application starts with a low default Quota, meant for evaluation. Its page shows the current Quota. See Quotas and 429 responses to ask for more.

Create an API Key

  1. On the Application page, under API Keys, enter a label in New API Key, such as production or staging.
  2. Select Create API Key.
  3. Copy the secret that the page shows, and store it in your server's secret store.

The portal shows the secret once. It keeps only a hash of it and its last four characters, so nobody can show it to you again. If you lose it, regenerate the key: see Authenticate with an API Key.

Send a request

Send the secret in the X-Api-Key header:

curl "$VIS_API_URL/..." \
  -H "X-Api-Key: $VIS_API_KEY"

Replace $VIS_API_URL with the address of the VIS API, and $VIS_API_KEY with your secret. A new key works within a few seconds of its creation.

Check your usage

The Usage tab of the Application shows your requests, errors, 429 responses, and latency over the last 24 hours, 7 days, or 30 days. Traffic shows there about a minute after the gateway serves it.

PreviousWelcome to the VIS API documentationNext Authenticate with an API Key