Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Account Information

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

  • 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 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 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 on the “MY APPS” tab.

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

  • After creating the app, you’ll be brought back to the “My Apps” page where you should be able to see your app. 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

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

  • No labels