All docs This doc
Skip to end of metadata
Go to start of metadata

To use the FreeAgent connector, add the  <freeagent.init>  element in your configuration before carrying out any other FreeAgent operations. 

Before you start performing various operations with the connector, make sure to import the FreeAgent certificate to your ESB client keystore.

Follow the below mentioned steps to add valid certificate to access FreeAgent API over https into the ESB client keystore:

  1. Extract the certificate from browse by navigating to ' https://api.sandbox.freeagent.com ' and click the lock icon on the address bar to view the certificate.
  2. Place the downloaded certificate into "FreeAgent_CONNECTOR_HOME/src/test/resources/keystores/products" folder.
  3. Navigate to "FreeAgent_CONNECTOR_HOME/src/test/resources/keystores/products/" using command prompt and execute the following command.
  4. This command will import FreeAgent certificate in to keystore. Give "wso2carbon" as password.To import the certificate give "wso2carbon" as password. Press "Y" to complete certificate import process.

    keytool -importcert -file CERT_FILE_NAME -keystore wso2carbon.jks -alias -alias "CERT_NAME"

FreeAgent uses OAuth 2.0. OAuth 2.0 allows FreeAgent users to authorize third party apps to access their data without sharing their FreeAgent login details. Instead, an app will have one access token and one refresh token for each authorized FreeAgent user account.  For more information on authentication, see https://dev.freeagent.com/docs/oauth.

init
<freeagent.init>
	<accessToken>{$ctx:accessToken}</accessToken>
    <apiUrl>{$ctx:apiUrl}</apiUrl>
</freeagent.init>
Properties  
  • accessToken:  The access token.
  • apiUrl:  The API URL of FreeAgent.

Configuring the message formatters and builders

Ensure that the following Axis2 configurations are added and enabled in the <ESB_HOME>\repository\conf\axis2\axis2.xml file.

Required message formatter
<messageFormatter contentType="text/html" class="org.wso2.carbon.relay.ExpandingMessageFormatter"/>
Required message builder
<messageBuilder contentType="text/html"	class="org.wso2.carbon.relay.BinaryRelayBuilder"/>

Configuring the operations

Now that you have connected to FreeAgent, use the information in the following topics to perform various operations with the connector.

  • No labels