Get Authorization Code

Overview

This is the initial step in authenticating with the Hover API using the OAuth 2.0 Authorization Code Grant Type. This request initiates the user consent process and ultimately generates an authorization code.

User Interaction Required

This step cannot be automated and requires direct user interaction:

1. When your application submits an authorization request, the user will be presented with a Hover login and consent screen in their browser.
2. The user must log into their Hover account and click the "Allow" button to grant your application access to their Hover organization's data.

Redirection and Authorization Code Retrieval

After the user grants permission, their browser will be redirected to the redirect_uri you specified in your request. The authorization code will be included as a query parameter in the URI, for example:

https://your-redirect-uri.com/?code={authorization_code}

Your application can then extract this authorization_code from the URI. This code is a one-time use credential that you will exchange for an access_token and refresh_token pair by calling the Generate Access Token.

Manually Retrieving the Authorization Code

For specific scenarios, such as generating an API token for manual testing or setup, you can manually retrieve the authorization code:

1. Construct the authorization request URI (as detailed in the "Query Parameters" section below).
2. Open this URI in your web browser.
3. Log in to Hover (if prompted) and click the "Allow" button.
4. The browser will redirect to your specified redirect_uri. The authorization code will be visible in the browser's address bar within the code query parameter.
5. Copy this authorization_code. You can then use it to manually request an access_token and refresh_token from the Generate Access Token endpoint.