API Documentation
      Back to home
      1. Help Center
      2. API Documentation

      Using An Apitoken

      How To Use An Apitoken In GSAPI

      General

      Since version 2020_2 GSAPI supports using a token when authenticating.

      Using this token improves performance of API queries as the system doesn’t have to complete extensive authentications for every request.

      Fetching A VompApiToken

      The token which is used in GSAPI requests is called VompApiToken.

      VompApiToken is always returned in the response headers of successful basic authentication.

      You can use the GSAPI call Welcome for this.

       
      mw1920_data_uri_upload20231122-17095-16lgw5r

       

      Upon successful response you now can find the authorization token. Retrieve this value.:

       
      mw1920_data_uri_upload20231122-17099-uqbu0m

      Using A VompApiToken

       
      mw1920_data_uri_upload20231122-17099-3r811k

      For future queries, add the retrieved token as authorization, as well as VompApiToken definition and test that the API works.

      Use the same authorization token for the future requests taking notice the expiration logic.

      Expiration and Renewal of A VompApiToken

      The token will be valid for 1440 minutes after a successful query. The expiration time will be extended every time the

      token is used until it expires when left unused.

      You will see a failed request:

      <Error>

          <Message>Authorization has been denied for this request.</Message>

      </Error>

      Then do a basic authentication to fetch a new token.