Quickstart Guide
This 5 minutes checklist helps you get all the requirements to start adding integrations to your product.
Prerequisites
Before you begin, make sure you have the following:
- A cloud account (or see our guide here on getting started with the selfhost version)
- An API key, see our guide here
- Node JS v18.17.1 or newer installed on your computer
Step 1: Get access to your users data
You either have the option to use a no-code magic link or the embedded frontend snippet to get access to your user’s data. Choose the one that fits your needs !
No Code: Magic links
Let’s send our first magic link so you can ask your customers to grant you access to their tools, without writing code.
Go to Connections section and click button Create a Magic Link
Create a Unique Magic Link
You’ll be asked for two informations: an Origin User Email
(of the user
you’re creating the link for) and an Origin User Identifier
. The Origin User Identifier
is the id of the user you’re inviting, as represented in your
sofwtare. If you already have created a Linked User you have the option to select
it.
Generate
For Developers: Native Integration
Embed Panora into your product with our native component to collect access to use user’s data.
You can find the component on NPM here
Install the package in your code:
Import the component and the styles in your integrations page:
Use the catalog in your integrations page
You can either import a single connector card or a catalog of all connectors that you select in the UI dashboard configuration (see here for more details).
linkedUserId
prop, use your own remote id that exist in your system OR check this recipe ! You should see a card or catalog being rendered client-side !
insert photo
Once the user successfully completes the granting auth flow, the connection will have a status
value of valid
.
Step 2: Send your first unified API requests
Create a contact in a CRM
We assume for this tutorial that you have a valid Panora API Key, and a
connection_token
. Find help here.
You can find the Typescript SDK on NPM here
In this example, we will create a contact in a CRM. Visit other sections of the documentation to find category-specific examples.
Let’s break down what’s happening here:
- We import the
Panora SDK
, which provides a convenient way to interact with the Panora Unified API. - We create an instance of the
Panora SDK
client, passing in our API key. - We call the
sdk.crmContact.addContact
method to add a contact inside a 3rd party. We specify the input we want to use (see here for reference). - Finally, we print the response.
Next Steps
Congratulations, you’ve successfully sent your first unified API request with Panora! Here are some next steps to continue your journey.
Listen to events using a webhook
Visit our webhooks section.
API resources
Drop into our API documentation for more details on the available endpoints and parameters.
Check out our client SDKs for a set of tools to make it easier for you to build with and integrate Panora into your applications.
Was this page helpful?