-
Notifications
You must be signed in to change notification settings - Fork 444
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.
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
Brightcrowd Integration #2783
base: master
Are you sure you want to change the base?
Brightcrowd Integration #2783
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
title: 'BrightCrowd' | ||
sidebarTitle: 'BrightCrowd' | ||
--- | ||
|
||
# BrightCrowd API Integration | ||
|
||
This page provides information about the BrightCrowd API integration in Nango. | ||
|
||
## API Description | ||
|
||
BrightCrowd is a platform designed to make connections effortless, effective, and enduring. It offers a unique approach to digital engagement, focusing on purposeful connections without the typical features of social networks like liking, commenting, or friending. BrightCrowd is used by higher education institutions, corporations, and non-profits for various purposes such as new student welcome, alumni reunions, new hire onboarding, and industry conferences. | ||
|
||
This integration allows you to interact with BrightCrowd's data, including books (which are collections of user profiles) and their members. | ||
|
||
## Key Features | ||
|
||
- Privacy-focused: Data shared is only visible to the specific group it's shared with. | ||
- Simplicity: The platform is designed to be intuitive and easy to use. | ||
- Purposeful engagement: Focuses on forming better relationships with peers and colleagues. | ||
- Versatile use cases: From higher education to corporate and non-profit sectors. | ||
|
||
## API Endpoints | ||
|
||
The BrightCrowd Partner API provides the following endpoints: | ||
|
||
- GET /books: List all books | ||
- GET /books/{bookId}: Get a specific book | ||
- GET /books/{bookId}/members: List members of a specific book | ||
- GET /books/{bookId}/members/{memberId}: Get a specific member of a book | ||
- POST /books/{bookId}/members: Add a new member to a book | ||
- PUT /books/{bookId}/members/{memberId}: Update a member in a book | ||
- DELETE /books/{bookId}/members/{memberId}: Remove a member from a book | ||
|
||
## Authentication | ||
|
||
BrightCrowd uses OAuth 2.0 Client Credentials flow for authentication. This ensures secure access to the API while maintaining the privacy standards that BrightCrowd upholds. | ||
|
||
## Rate Limits | ||
|
||
[Include information about rate limits if available] | ||
|
||
## Use Cases | ||
|
||
BrightCrowd can be used for various purposes, including: | ||
|
||
1. Higher Education: | ||
- New Student Welcome | ||
- Alumni Reunions | ||
- Sports Teams | ||
- Affinity Groups | ||
|
||
2. Corporate & Non-profit: | ||
- New Hire Onboarding | ||
- Corporate Teams & Events | ||
- Non-profit Networks | ||
- Industry Conferences | ||
|
||
## Resources | ||
|
||
- [BrightCrowd API Documentation](https://brightcrowd.com/partner-api#/) | ||
- [BrightCrowd About Us Page](https://brightcrowd.com/about) | ||
- [BrightCrowd Blog](https://brightcrowd.com/about#blog-section) | ||
|
||
For more information about BrightCrowd and its features, visit their [official website](https://brightcrowd.com/). |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -787,6 +787,27 @@ calendly: | |||||
- owner | ||||||
docs: https://docs.nango.dev/integrations/all/calendly | ||||||
|
||||||
brightcrowd: | ||||||
display_name: BrightCrowd | ||||||
categories: | ||||||
- alumni-data | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you also add it to social.mdx please |
||||||
auth_mode: BASIC | ||||||
token_url: https://bcb-staging.auth.us-east-1.amazoncognito.com/oauth2/token | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is staging correct? |
||||||
token_request_auth_method: basic | ||||||
token_params: | ||||||
grant_type: client_credentials | ||||||
scope: bcb.partner/book.read | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure it's correct, you have to request this scope in your own integration no? |
||||||
proxy: | ||||||
base_url: https://brightcrowd.com/partner-api | ||||||
headers: | ||||||
Content-Type: application/x-www-form-urlencoded | ||||||
paginate: | ||||||
type: cursor | ||||||
cursor_path_in_response: next_cursor | ||||||
cursor_name_in_request: cursor | ||||||
limit_name_in_request: limit | ||||||
docs: https://docs.nango.dev/integrations/all/brightcrowd | ||||||
|
||||||
canny: | ||||||
display_name: Canny | ||||||
categories: | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you can follow other documentation models that would be great. No need to fill information if you are not sure