From f8abcf83afb8752efc6226e5d5d59d89849b759a Mon Sep 17 00:00:00 2001 From: nael Date: Fri, 17 May 2024 19:56:44 +0200 Subject: [PATCH] :memo: Updated some docs --- docs/core-concepts/auth.mdx | 46 ++++++++++++++++-------------- docs/core-concepts/magic-links.mdx | 14 +++++---- docs/open-source/contributors.mdx | 9 +++--- docs/quick-start.mdx | 2 +- 4 files changed, 38 insertions(+), 33 deletions(-) diff --git a/docs/core-concepts/auth.mdx b/docs/core-concepts/auth.mdx index ab2ea49d2..b7dc8e973 100644 --- a/docs/core-concepts/auth.mdx +++ b/docs/core-concepts/auth.mdx @@ -31,7 +31,7 @@ Depending on your setup, you should make requests to one of those endpoints: -## Learn how to generate your API Keys and catch connection tokens. +## Learn how to generate your API Keys @@ -46,31 +46,33 @@ Depending on your setup, you should make requests to one of those endpoints: Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. - + - A `connection_token` is created everytime a user connects an account to your platform. - You need to setup a webhook and listen to events tagged as `connection.created` to catch a it. - The `connection_token` is a string, located in the _data_ object, inside a `connection.created` event. +## Catch connection tokens - Read more about webhooks [here](/webhooks/overview) +A `connection_token` is created everytime a user connects an account to your platform.
+Once you've set up the auth flow through [magic-link or using the mbedded snippet](/quick-start), you need to setup a [webhook](/webhooks/overview) and listen to events tagged as `connection.created`. - ```json Example connection.created event - { - "id_event": "dc2d12b9-dd07-4e33-a244-d0560a9eeed7", - "type": "connection.created", - "data": { - "id" : "6fc7017a-6596-4b05-81b6-595296a59f87" - "connection_token": "MY_CONNECTION_TOKEN", - "provider_slug": "hubspot", - ... - }, + + The `connection_token` is a string, located in the _data_ object, inside a + `connection.created` event. + + +```json Example connection.created event +{ + "id_event": "dc2d12b9-dd07-4e33-a244-d0560a9eeed7", + "type": "connection.created", + "data": { + "id" : "6fc7017a-6596-4b05-81b6-595296a59f87" + "connection_token": "MY_CONNECTION_TOKEN", + "provider_slug": "hubspot", ... - } - ``` - Congrats! You have everything you need to make authenticated requests. - + }, + ... +} +``` - +Congrats ! You have everything you need to make authenticated requests. ## Make your first API request with your `API Key` and a `connection_token` @@ -170,4 +172,4 @@ We also recommend practising by looking at the specific verticals you want to in ``` -Read more about our SDKs in [TypeScript](/backend-sdk/typescript), [Java](/backend-sdk/java), [Python](/backend-sdk/python) +Read more about our SDKs in [TypeScript](/backend-sdk/typescript), [Python](/backend-sdk/python). diff --git a/docs/core-concepts/magic-links.mdx b/docs/core-concepts/magic-links.mdx index f421e4b24..97cee3a2f 100644 --- a/docs/core-concepts/magic-links.mdx +++ b/docs/core-concepts/magic-links.mdx @@ -4,11 +4,13 @@ description: "Use Magic Links to invite your users to grant you access to their icon: "wand-magic-sparkles" --- -Hero Light + + Hero Light + ## Send your first Magic Link @@ -31,4 +33,4 @@ icon: "wand-magic-sparkles" Once the user successfully completes the granting auth flow, the connection will have a `status` value of `valid`. -We recommend listening to [webhooks](/webhooks/overview) to get notified once a user connects. +We recommend listening to [webhooks](/webhooks/overview) to get notified once a user connects and catch the connection token used for requests. diff --git a/docs/open-source/contributors.mdx b/docs/open-source/contributors.mdx index 3f9154f41..6d7cbe935 100644 --- a/docs/open-source/contributors.mdx +++ b/docs/open-source/contributors.mdx @@ -20,10 +20,10 @@ We made a docker file that builds Panora from sources, specifically to help you - You must create manually a custom oAuth2 app inside the 3rd party and copy the - critical values (_client id and client secret_) + You must manually create a custom OAuth2 App inside the 3rd party and copy the + critical values (likely _client id and client secret_) - You have the option to manage a custom 3rd party oAuth app. + You have the option to manage a custom 3rd party OAuth App. **Each custom 3rd party environment variable must be of the form `PROVIDER_VERTICAL_SOFTWAREMODE_ATTRIBUTE` where** @@ -88,7 +88,7 @@ It should be available (if not [contact us](https://app.cal.com/rflih/30)) with Actually an integration is built in 2 parts : - the **authentication part** (oauth, api key, basic etc) which is built by the Panora team -- the **service integration** where the mapping is created with our unified model which is what you'll build +- the **service integration** where the mapping with our unified model is created whixch is what you'll build in the next steps # Step 2: Build your provider service @@ -224,6 +224,7 @@ For the sake of this guide, let's map the common object `contact` under `crm` ve + After these 3 files are successfully created and filled, you are ready to to fix all dependencies/linting issues that you may have.
To make sure the service is enabled, dependencies and imports must be added.
We built a script that does it in seconds. You can execute the given command from the root directory of Panora. diff --git a/docs/quick-start.mdx b/docs/quick-start.mdx index 0c051d055..500a56ee8 100644 --- a/docs/quick-start.mdx +++ b/docs/quick-start.mdx @@ -88,7 +88,7 @@ Choose the one that fits your needs ! Once the user successfully completes the granting auth flow, the connection will have a `status` value of `valid`. -We recommend listening to [webhooks](/webhooks/overview) to get notified once a user connects. +We recommend listening to [webhooks](/webhooks/overview) to get notified once a user connects and catch the connection token used for requests. ## **Step 2: Send your first unified API requests**