This documentation will walk you through how you can setup the Connect button (authorization) for your users to click-to-connect their accounts.
To get started, you need to register your app with the service provider. Each provider will have a dedicated developer space that will allow you to do this.
We have created the setup documentation for a few providers. This can be found here: Integration Setup Docs
If you need help identifying where to register your app with a particular provider, reach out to us and we will get back with the steps for it.
When asked for a Redirect URI, enter the following Pathfix URI: https://labs.pathfix.com/integrate/command
Once you have registered, save the client ID and client secret for use with Pathfix.
- Add your application by clicking Add Application (or select an application from the list)
- (Optional Security step, see more here) Click on Edit under your Application, add your app domain and hit Save
- Select the Application and pick a provider from the list (depending on the auth method offered by the provider, you can choose from OAuth, Identity, Client Key based or API Key based integration)
- Add the client_ID and client_secret received from the provider
- Add/Edit the scopes you want to access and hit save
Before proceeding, you will need to test the connection to make sure your setup, keys and scopes are correct. Here is how you can run a complete test before proceeding to add the Connect button to your app:
- Once you have added the provider configuration, click on Test Connection
- You will be on the API Playground where you can click and connect your account
- Connect your account to proceed
- If your provider developer account has been setup correctly, you will be connected successfully
- Once connected, you should see a few Sample methods for the provider
- Select any of the sample methods, click on Send and run an API call
- The Response section will show the response received from the provider
Your test is now complete and you are ready to add the Connect button to your app for your users to click to connect their accounts.
Add the Connect button to your page to allow your users to connect and authorize your app (e.g. Add to Slack, Connect to Google etc.)
- Click on Setup and select OAuth Connect Buttons to get your code
You will need to add 2 pieces of script to your page to enable the connection.
- Add the following script to the <head> section of your App:
Change (MarketSaaS_end_user_id) with the user ID associated with your app. This is generally the email address or unique username or any unique ID associated with your user in your app database.
- Add the following script to the Button (Body) on your app to add the functionality
You can change the display text as per your requirements.
Your authorization connection to the service provider is now active.
This will add the functionality that will allow the users to click-to-connect to their account for the service provider.
Pathfix will handle the connection, manage the Access and Refresh Tokens for each user against each provider integration.
Next step is to send API requests (payload) between your app and the service provider, read our documentation on how you can Enable pass-through API.
Need help? Reach out to us at firstname.lastname@example.org and we would be happy to assist!