Skip to content

Add details for Linkedin Pages integration #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 26, 2024
Merged

Add details for Linkedin Pages integration #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cedb93f
Add Linkedin Role
cmathews393 Dec 16, 2024
ac5894d
Rename Screenshot 2024-12-16 133749.png to linkedin-003.png
cmathews393 Dec 16, 2024
86ceda3
Create linkedin-pages.mdx (#1)
cmathews393 Dec 16, 2024
13514d2
Update and rename linkedin-pages.mdx to linkedin-page.mdx
cmathews393 Dec 16, 2024
b641040
Add files via upload
cmathews393 Dec 16, 2024
b1e490d
Update linkedin-page.mdx
cmathews393 Dec 16, 2024
0259f71
Update linkedin-page.mdx
cmathews393 Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions pages/providers/linkedin-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: LinkedIn Page
description: How to add a LinkedIn Page to your system
---

import OAuth2Redirect from "../../components/snippets/oauth2redirect.tsx";

Head over to [LinkedIn developers](https://www.linkedin.com/developers/apps) and create a new app.
![Linkedin](/images/providers/linkedin/linkedin-001.png)

Verify your app with LinkedIn
![Linkedin](/images/providers/linkedin/linkedin-004.png)

You will need to follow the verification process to request the necessary permissions listed below.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

List the specific permissions required for integration.

The documentation mentions "necessary permissions" but doesn't list them explicitly. This could lead to confusion during setup.

Add a list of required permissions, for example:

 You will need to follow the verification process to request the necessary permissions listed below. 
+
+Required permissions:
+- r_organization_social
+- rw_organization_admin
+- w_organization_social
+- w_member_social
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You will need to follow the verification process to request the necessary permissions listed below.
You will need to follow the verification process to request the necessary permissions listed below.
Required permissions:
- r_organization_social
- rw_organization_admin
- w_organization_social
- w_member_social


Fill in all the details, once created head over to Products and make sure you add all the required products.
![Linkedin](/images/providers/linkedin/linkedin-003.png)

Comment on lines +16 to +18
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add OAuth redirect URL configuration steps.

Critical configuration steps for OAuth callback URLs are missing.

Add instructions for configuring OAuth redirect URLs:

 Fill in all the details, once created head over to Products and make sure you add all the required products.
 ![Linkedin](/images/providers/linkedin/linkedin-003.png)
+
+Configure the OAuth 2.0 settings:
+1. Go to the Auth tab in your LinkedIn app
+2. Add the following OAuth 2.0 redirect URL:
+   ```
+   https://your-domain.com/api/auth/callback/linkedin-page
+   ```
+3. Save the changes
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Fill in all the details, once created head over to Products and make sure you add all the required products.
![Linkedin](/images/providers/linkedin/linkedin-003.png)
Fill in all the details, once created head over to Products and make sure you add all the required products.
![Linkedin](/images/providers/linkedin/linkedin-003.png)
Configure the OAuth 2.0 settings:
1. Go to the Auth tab in your LinkedIn app
2. Add the following OAuth 2.0 redirect URL:

It is important to request the Advertising API permissions and fill up the request form, or you will not have the ability to refresh your tokens.

<OAuth2Redirect provider = "linkedin-page" />
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance OAuth implementation documentation.

The OAuth implementation section needs more context and error handling guidance.

Add more detailed implementation information:

+## OAuth Implementation
+
+The OAuth2 authentication flow consists of the following steps:
+1. User initiates the LinkedIn Page connection
+2. User is redirected to LinkedIn for authorization
+3. After authorization, LinkedIn redirects back to your application
+
 <OAuth2Redirect provider = "linkedin-page" />
+
+### Error Handling
+
+Common OAuth errors and how to resolve them:
+- `invalid_request`: Check if all required parameters are properly configured
+- `access_denied`: User denied the authorization request
+- `invalid_scope`: Verify the requested permissions are approved in your LinkedIn app
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<OAuth2Redirect provider = "linkedin-page" />
## OAuth Implementation
The OAuth2 authentication flow consists of the following steps:
1. User initiates the LinkedIn Page connection
2. User is redirected to LinkedIn for authorization
3. After authorization, LinkedIn redirects back to your application
<OAuth2Redirect provider = "linkedin-page" />
### Error Handling
Common OAuth errors and how to resolve them:
- `invalid_request`: Check if all required parameters are properly configured
- `access_denied`: User denied the authorization request
- `invalid_scope`: Verify the requested permissions are approved in your LinkedIn app



Copy the created `Client ID` and `Client Secret` and add them to your `.env` file.

```env
LINKEDIN_CLIENT_ID=""
LINKEDIN_CLIENT_SECRET=""
```
You can find those under the Auth Tab of your LinkedIn App in the developer portal.
Comment on lines +24 to +30
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add security best practices for credential handling.

The environment configuration section should include security recommendations.

Add security guidelines:

 Copy the created `Client ID` and `Client Secret` and add them to your `.env` file.

 ```env
 LINKEDIN_CLIENT_ID=""
 LINKEDIN_CLIENT_SECRET=""

-You can find those under the Auth Tab of your LinkedIn App in the developer portal.
+You can find these credentials under the Auth Tab of your LinkedIn App in the developer portal.
+
+### Security Best Practices
+
+1. Never commit your .env file to version control
+2. Use different credentials for development and production
+3. Regularly rotate your Client Secret
+4. Store production credentials in a secure secret management system


<!-- This is an auto-generated comment by CodeRabbit -->

Binary file added public/images/providers/linkedin/linkedin-003.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/providers/linkedin/linkedin-004.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.