API Gateway Quick Start Guide

The following sections describe how to access the APIs available on the APIClosed Application Programming Interface Gateway.

Create an Account on the API Gateway

You need an API Gateway account to access the products and services on the API Gateway. Use the following procedure to create an account.

If you already have an API Gateway account, proceed to Sign In to the API Gateway.

  1. Open a browser and navigate to the API Gateway.

    ecommportal.hexagonap.com

  2. Click the Sign up button or use the following link ecommportal.hexagonap.com/signup.

    The Sign up screen appears.

  3. Enter information into all of the fields and click the Sign up button.

The API Gateway will send an email to the email account you provided on Sign up page. Click on the link provided to activate your account and log in.

Account Confirmation

After you create an account on the API Gateway, inform your NovAtel contact that you have created an account. NovAtel will confirm with the authorized NovAtel contact at your company that you are authorized to access the APIs on behalf of your company.

This manual step is to ensure integrity and protection for both NovAtel and your company.

Sign In to the API Gateway

  1. Open a browser and navigate to the API Gateway.

    ecommportal.hexagonap.com

  2. Click the Sign in link located in the top right of the Welcome screen.

    The Sign in screen appears.

  3. Enter the email and password associated with your API Gateway account.

  4. Click the Sign in button.

Subscribe to a API Product Group

The APIs available on the API Gateway are organized into groups based on the functionality provided by the API. To access an API, you must subscribe to an API product group.

  1. From the API Gateway main page, click the Products link or use the following link ecommportal.hexagonap.com/products.

    The Products page appears. This page lists the API product groups available.

  2. Click the name of a product group.

    The subscription page for the selected product group appears.

    This page lists the APIs available within this product group. To view the operations available in an API, click the name of the API.

  3. Enter a descriptive name for the product group and click the Subscribe button.

    A request for access to the product group is sent to NovAtel. When the request has been approved, the API will be available for use.

    To view the status of the subscription request, check the Subscriptions section of the User Profile page.

View Subscription Status

  1. From the API Gateway main page, click the Profile link or use the following link ecommportal.hexagonap.com/profile.

    The User profile page appears.

The Subscriptions section shows information about all of the product groups to which you are subscribed. The subscriptions that are awaiting approval have the State listed as Submitted. Approved subscriptions have the State listed as Active.

View API Product Group Information

Information about the APIs to which you are subscribed is available on the API page.

  1. From the API Gateway main page, click the APIs link or use the following link ecommportal.hexagonap.com/apis.

    The APIs page appears. This pages lists all of the subscribed API product groups with a description of the product group.

  2. Click the name of a product group to view information about the APIs within the product group.

    The API product group page appears with detailed information about the APIs in the product group.

Request Secret Code

An access token is required as part of all API calls. To generate an access token, your application needs a secret code provided by NovAtel.

To obtain a secret code:

  1. Contact NovAtel Support and request a secret code.

  2. NovAtel Support will use a secure transmit method to send your code to the authorized NovAtel contact in your company.

Access tokens generated from your secret code expire after one hour, so the application that is communicating with the NeCSClosed NovAtel e-Commerce System will need to generate new access tokens on a regular basis. For information about generating access tokens, refer to API Gateway Integration.

Response Codes

The response codes provided from API requests are described on the Response Codes page, see ecommportal.hexagonap.com/responsecodes.