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 but must register a user account in and can use their Geopath credentials to access the Geopath API portal.

• Member organizations can have multiple accounts based how many developers they have.

Creating an account

• Create a new portal account by registering  your email associated with your corporate email account. Geopath will be notified that you have registered and will approve your account if you are working for, or on behalf of a Geopath member.

• Once you have received a confirmation email letting you know that your account has been approved, return to the 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.

• If you forget your password or need to reset it, you can request a new password and a link will be sent to your email with directions to do so.

• Once you have logged in, you may view your profile and make edits to your username, password, and preferences.

Creating an Application

• Once you have an account to 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 “MY APPSApps” taboption.

• Click the “Add A New App” Button in to 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.

  • The callback URL field is optional for your organization. If you are unsure if this applies to your organization, leave it blank.

  • Select the Geopath-insights-api-Product Version 2. This is important as this is current version of the Geopath API and the most up to date products.

  • Click “Create App”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 back to the “My Apps” 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. All the apps you create will be listed here. If you want to create an additional app, click the “Add A New App “button on this page and fill out the information on the new page again.

• Click the link of the app you just created the record will expand to show the details of your app. These details include the API key and API secret key which you will need to use to help give your app access to the various API products and endpoints. You can also see analytics about your app as well as edit or delete it.

• Best Practice

• 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 individual 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.