Skip to content
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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

travistatro
Copy link

@travistatro travistatro commented Sep 27, 2024

Describe your changes

  1. Added BrightCrowd integration to Nango, including:
  2. Documentation file brightcrowd.mdx with API description, key features, endpoints, authentication method, use cases, and resources.
  3. API configuration in providers.yaml
  4. SVG logo for BrightCrowd

Checklist before requesting a review (skip if just adding/editing APIs & templates)

[-] I added tests, otherwise the reason is: This PR is only adding documentation for a new API integration
[-] I added observability, otherwise the reason is: Not applicable for API documentation
[-] I added analytics, otherwise the reason is: Not necessary for adding a new API integration documentation
The main changes are in the following file:

Copy link
Collaborator

@bodinsamuel bodinsamuel left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution. It would be great to share the documentation if you have some so we can double check the values there

@@ -0,0 +1,65 @@
---
Copy link
Collaborator

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

brightcrowd:
display_name: BrightCrowd
categories:
- alumni-data
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- alumni-data
- social

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you also add it to social.mdx please

token_request_auth_method: basic
token_params:
grant_type: client_credentials
scope: bcb.partner/book.read
Copy link
Collaborator

Choose a reason for hiding this comment

The 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?

categories:
- alumni-data
auth_mode: BASIC
token_url: https://bcb-staging.auth.us-east-1.amazoncognito.com/oauth2/token
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is staging correct?
they don't advertise any API on their website, not confident about this URL

@hassan254-prog
Copy link
Contributor

@travistatro , just to add on what @bodinsamuel has mentioned, according to the provider's documentation, the authentication mode should beOAUTH2_CC

@hassan254-prog
Copy link
Contributor

@travistatro , just to add on what @bodinsamuel has mentioned, according to the provider's documentation, the authentication mode should beOAUTH2_CC

Probably this would work but will have to confirm by creating a new connection on Nango and also try on the pagination especially limit_name_in_request as it hasn't been mentioned in the docs :

brightcrowd:
    display_name: BrightCrowd
    categories:
        - social
    auth_mode: OAUTH2_CC
    token_url: https://bcb-staging.auth.us-east-1.amazoncognito.com/oauth2/token
    token_request_auth_method: basic
    token_params:
        grant_type: client_credentials
    proxy:
        base_url: https://api.brightcrowd.com/partner
        headers:
            Accept: application/problem+json
        paginate:
            type: cursor
            cursor_path_in_response: nextPageToken
            cursor_name_in_request: pageToken
            limit_name_in_request: limit
    docs: https://docs.nango.dev/integrations/all/brightcrowd
   

@travistatro
Copy link
Author

Thanks for your contribution. It would be great to share the documentation if you have some so we can double check the values there

Thank you for the feedback/responses. I am sharing this with an engineer on my team to help move some of this forward!

@hassan254-prog
Copy link
Contributor

hassan254-prog commented Nov 8, 2024

@travistatro , I have opened a new PR in reference to this. Could you be having test credentials to test the implementation?

github-merge-queue bot pushed a commit that referenced this pull request Nov 13, 2024
## Describe your changes

- Add support for brightcrowd

- Follow up to [2783](#2783)

- Placing this in draft to see if we can get it tested.

## Issue ticket number and link

[EXT-222](https://linear.app/nango/issue/EXT-222/clean-up-pr-to-get-it-pushed-to-the-platform)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants