Getting started
Activate Connector
To enable integrations for your consumers, you first need to activate the connectors you want to use. This guide will walk you through the connector activation process.
Example of a connector with partner key and post-connexion:
Access the Connectors Page
- Log in to your Chift account
- Navigate to the Connectors page on the environment you want to activate the connector for
- You’ll see a list of all available connectors organized by category (Accounting, eCommerce, POS, etc.)
Specific connectors might not be available for your account. Please contact
your customer success manager if you need help.
Activate a Connector
- Find the connector you want to activate in the list
- Click on “View connector” to open its details
- At the top of the connector page, you’ll see a “View documentation” link. It opens a separate page with detailed instructions and context about the connector. We recommend checking it before continuing configuration.
- On the same page, you’ll also find the following configuration sections:
| Section | Description |
|---|---|
| General | Choose whether you want your end-user to enter a name for the connection. This is a free field that can help you and your end-user to identify the connection. This is optional. You can also provide a Help URL, which will be shown to the end-user when activating the connector. If you leave it empty, we will display Chift’s default documentation for the connector. |
| Preconfigure fields | Some fields can (and must) be configured at connector level. Typically those fields are partner specific and must not be entered by the end-user. |
| Oauth2 | If the connector uses OAuth2, you will have to preconfigure the client id and client secret. We connect through your app to let end-users authorize your app to access their data. |
| Post-connexion configuration | Post-connexion configuration can be used to let the end-user select some options after authentication. For example, this is helpful to let the end-user select the accounting folder or location they want to connect. Some post-connexions are mandatory. Some are optional and activation might depend on your implementation and what you want to offload to Chift. When post-connexions are used, data is automatically filtered based on the selection of the end-user. |
- Click the “Activate” button to enable the connector
Example of a connector with partner key and post-connexion:
Connectors need to be activated separately for each environment you’re working
in (Sandbox, Production). This allows you to test integrations in a sandbox
environment before deploying to production.
Managing Active Connectors
- You can view all your activated connectors through the “Show Active” filter
- You can search for a connector by name or filter by Unified API
- To deactivate a connector, you can use the toggle button on the connector card. Note that you can only deactivate connectors that are not currently connected to any consumer.
Next Steps
Once you’ve activated your desired connectors, you can:- Create consumers who will use these connectors
- Generate API keys to access the APIs
- Start building integrations using our API documentation
Make sure to activate connectors as well in your production environment when
you are ready to go live. Your credentials for the production environment
might be different from your sandbox credentials.