GetOAuthAccessToken
Obtains the OAuth access token to be used for authentication with FreshBooks.
Input
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication you are attempting. Use App for a Windows application, or Web for Web-based applications.
デフォルト値はAPPです。 |
| Verifier | String | False | A verifier returned by the service that must be input to return the access token. Needed only when using the Web auth mode. Obtained by navigating to the URL returned in GetOAuthAuthorizationUrl. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
| GrantType | String | False | Authorization grant type. Only available for OAuth 2.0.
使用できる値は次のとおりです。CODE, PASSWORD, CLIENT, REFRESH デフォルト値はCODEです。 |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the FreshBooks authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns
| Name | Type | Description |
| OAuthAccessToken | String | The OAuth access token. |
| OAuthRefreshToken | String | The OAuth access token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |