Connecting to FreeeInvoice
To authenticate to freee Invoice, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.
Using OAuth Authentication
First you will need to create an OAuth app. To do so, navigate to https://app.secure.freee.co.jp/developers/applications and click Create New Application button. Give the application name, Redirect URL, and click Register. You will then be given your Client Secret and Client ID
And, You get CompanyId from Comapnies view. After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to OAuth.
- OAuthClientID: Set this to the OAuth Client ID that is specified in your app settings.
- OAuthClientSecret: Set this to the OAuth Client Secret that is specified in your app settings.
- CallbackURL: Set this to the Redirect URI you specified in your app settings.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
Example Connection String
Profile=freeeinvoice.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
Connection Properties
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
Property | Description |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
CompanyId | Your Comapny Id of freee. |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. Allowed values are: OFF, GETANDREFRESH, REFRESH |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |