Account Information

• A Geopath user account is required to be able to access the Geopath API Documentation Portal.

• Only Geopath members can use the Geopath API. It is not available for public use.

• Any Geopath member can gain access to the Geopath API and can use their Geopath credentials to access the Geopath API Documentation Portal.

Creating an account

• If you do not have Geopath credentials, you can request them by signing up.

  • Geopath credentials are the username/password that is used to sign in to applications like the Geopath Insights Suite.

  • Please only register using a corporate email address. There will be a delay or rejection in processing non corporate email accounts.

• After the account is validated and created, you will receive an email from Member Services prompting you to set a password. Once you have, you can return to the login page and enter your username or email and password.

Creating an Application

• Once you access the portal, you will be able to register an application and retrieve an API key which will allow you to use the various API products. The application registration provides an API key that is required for calling the various API products and endpoints.

• To set up a new app, click the dropdown under your username in the upper right corner of the page and click on the “Apps” option.

• On the “My Apps” page, click the “+ New App” button in the upper right corner to create a new app.

• On the new page, give your app a name in the App Name Field.

  • A description of the app is optional, but will help manage and identify the app if you have more than one.

  • Enable the APIs you want the application to be able to access.

  • Click “Save” on the lower right corner of the page

• After creating the app, you’ll be brought to a page where you should be able to see your app details including the API key.

• Geopath reviews all app creation requests and will either approve or reach out for more information in a timely manner.

• To see all your apps, you can return to the “My Apps” page by selecting Apps in the dropdown under your username in the upper right corner of the screen.

• Geopath recommends creating an API application for each downstream application or service being created. This will allow for more granular monitoring of your API usage.

Teams

• The API supports the ability to set up a developer team. This allows a user to create a team and invite other users to join the team, and create API keys that can be shared by team members.

  • Team members can be set as an “Owner”, “App Admin” or “Viewer”.

    • Owner:

      • Full read and write privileges for developer team members, developer team details, and apps.

    • App Admin:

      • Read-only privileges for developer team members and developer team details.

      • Read and write privileges for apps.

    • Viewer:

      • Read-only privileges for developer team members, developer team details, and apps.

• Team members who do not have Geopath credentials will still need to register for credentials to be able to access the documentation portal.

• API usage on teams apps will be credited to the parent company in the same way as an individual app.

• Team “Owners” and “App Admins” can create a new app for their team, by selecting the “+ New App” button on the lower let corner of the Team page.