Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Obtaining the Session Token

All VB-Mapp Content Server REST API calls require an authorization token to allow access to the server.  The token can be found on the User page when logged in at http://data-sandbox.vbmappapp.com.

Image Removed

Formatting the REST Request

...

  • Authorization: Token token="<your session token here>"
  • Content-Type: application/json
  • User-Agent: dmid-rest-api
  • X-ClientId: <the client id here>
  • X-ClientCode: <the client code here>

...

  • Accept-Language: <language> – Currently 'en' is supported (English), 'es' , (Spanish) and 'fr' coming soon)

...

  • (French) are supported


Info

The 'X-ClientId' and 'X-ClientCode' header is not required on all requests.  However, when they are required either of the two may be provided to authenticate the call, both are not simultaneously required.

X-ClientCode equates the code field that is provided when the client record is created. This allows you to store a unique value in the code field, for example your primary key, and thus no changes to your data model are required to integrate the REST service.

...

Panel

curl -X GET \
-H 'Authorization: Token token="c1b297a8e1fda144588ee1f9ce23b23a"' \
-H "Accept: application/json" \
-H "User-Agent: dmtd-reset-api" \
-H "Content-Type: application/json" \
-H "X-ClientId: 1" \
-H "Accept-Language: en" \
  http://dataapi-sandbox.vbmappappdatamtd.com/1/vbmapp/index

 

 

...