Set Up Steps for the API Proxy

We’ve made using the VAN API Proxy as easy as possible – all you have to do is swap the host name and add the X-MIGVID request header to your VAN API requests.

The VAN API Proxy supports all VAN API /v4 routes and passes responses through with minimal changes. Two exceptions are worth knowing: a bulk-import request may be accepted for deferred forwarding and answered with 204 and an X-MIG-BulkImport: Saved header instead of VAN's own response, and Location response headers are rewritten to point at the Proxy. If the specific endpoint you’re sending data to in VAN already has webhook notifications configured, you will continue to receive those notifications from VAN.

The Proxy applies a rate limit of 100 requests per minute per credential.

1. Swap Host Name URL
   1. Change your hostname endpoint URL from https://api.securevan.com to the
      API Proxy endpoint: https://vanapi.movementinfrastructure.org
      1. Example DDx API endpoint structure: https://vanapi.movementinfrastructure.org/v4/apiKeyProfiles
2. Set the request header to the X-MIGVID provisioned by the DDx API team
   1. Example request header: X-MIGVID: mig.c8f2edd4-9a9b-415c-beb2-354fae09747a
   2. If you need access to this header at any point, please reach out to us at [email protected].
3. Follow the same steps as your usual VAN API request paths

For further support on the details of VAN API authentication steps, refer to the VAN Authentication documentation.

For questions or assistance getting set up please contact DDx API Support at [email protected]

Examples

Updated API URL

Here is an example of what your updated API URL should look like:

   VAN_API_APP_NAME='example.000.001'
   VAN_API_KEY='1173483d-77d6-4c72-8159-a135a5829aff'
   VAN_DATABASE_MODE=1
   API_URL='https://vanapi.movementinfrastructure.org'
   MIGVID='mig.c8f2edd4-9a9b-415c-beb2-354fae09747a'

Request header X-MIGVID Example

Here is an example of an updated request header X-MIGVID (provided to you as part of your onboarding):

 #The same call as above, with the additional X-MIGVID header
   curl -X POST \
    -u "$VAN_API_APP_NAME:$VAN_API_KEY|$VAN_DATABASE_MODE" \
    -H 'Content-Type: application/json' \
    -H "X-MIGVID: $MIGVID" \
    -d '{"message":"Hello!"}' \
    $API_URL/v4/echoes

Errors and Troubleshooting

The Proxy emits two types of errors: proxied VAN errors, and API Proxy errors. Proxy-based errors carry source: "proxy" to distinguish them from VAN's own.

See Errors & Troubleshooting for the full list with examples.