Set Up Chart Connect

​

Implementing Chart Connect in your application

1. Choose your preferred flow: Chart provides several Frontend SDKs for easy integration. Select the SDK that best suits your application’s technology stack. Otherwise, you can use the Redirect flow.
   • React SDK: If you’re using React as your frontend framework, use the React SDK. Import the Chart Connect component and include it in your application. You can find examples and usage instructions in the SDK documentation or continue to follow this tutorial.
     • npm install --save @chartapi/react-connect
     • yarn add @chartapi/react-connect
   • JavaScript SDK: If you’re using a different frontend framework or vanilla JavaScript, use the pure JavaScript SDK. Include the Chart Connect library in your application, either by adding a script tag to your HTML file or by importing it as a module.
     • <script src="https://cdn.trychart.com/script.js"></script>

       Since Chart Connect is an iFrame that requires interactivity, the HTML page that is loading Chart Connect must be served from a server. If the page is hosted statically, Chart Connect will not work properly.

   • Redirect Flow: The redirect flow is helpful in instances where you do not have a user interface (such as a link in an email) or you prefer to redirect in order to not host the authorization experience yourself.
2. Configure Chart Connect: Every flow requires you to configure Chart Connect with your unique client_id. You can find this client_id in your Chart Developer Dashboard.

​

Redirect to Chart Connect

https://connect.trychart.com?
client_id=<your_client_id>
&redirect_uri=https://example.com

1. Open Chart Connect — Your application redirects your user’s browser to Chart Connect to initiate the authorization flow.
2. Obtain consent — Chart Connect prompts your user to log in to their tax system and grant your application access to the permissions you are requesting.
3. Retrieve the authorization code — If your user successfully connects and grants your application access to their system, Chart Connect will redirect their browser to a specified redirect_uri with a short-lived authorization code.
4. Exchange the code for an access token — Before sending API requests, your application will exchange the short-lived code for a long-lived access_token that represents your application’s access to your user’s tax system.

​

Embedded Chart Connect

NOTE: You should not include a redirect_uri if using the embedded flow. Because the entire flow is already self-contained in your app, no redirect is necessary.

import React, { useState } from "react";
import { useChartConnect } from "@chartapi/react-connect";

const App = () => {
  const [code, setCode] = useState(null);

  const onSuccess = ({ code }) => setCode(code);
  const onError = ({ errorMessage }) => console.error(errorMessage);
  const onClose = () => console.log("User exited Chart Connect");

  // 1. Initialize Chart Connect
  const { open } = useChartConnect({
    clientId: "<your-client-id>",
    state: "", // optional
    onSuccess,
    onError,
    onClose,
  });

  // ...
};

const App = () => {
  // ...

  // 2. Display Chart Connect
  return (
    <button type="button" onClick={() => open()}>
      Open Chart Connect
    </button>
  );
};

1. onSuccess: This event is triggered when the user completes the authentication process. It returns an authorization code that you will use to obtain an access_token in the next step. Pass this authorization code securely and temporarily to the access token exchange function.
2. onError: This event is triggered if there’s an issue during the authentication process. Your application should handle this error gracefully, either by displaying an error message to the user or retrying the authentication flow.
3. onClose: This event is triggered when a user exits the Chart Connect model, either by closing the modal or clicking outside the modal.

​

Checkpoint + Next Step

​

Learn more

• Chart SDKs