Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nango.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

The easiest way to add a new API is to request it from the Nango team. If you have a shared Slack channel with Nango, send your request there. Otherwise, post in the #request-a-new-api channel of the community. We’ll deliver them according to the SLAs on our pricing page.

​
Option 2: Contribute a new API yourself

To contribute a new API, follow the steps below and check out past PRs starting with feat(integrations) for examples.

​
Pre-requisites

  • You have access to a test account for the API
  • The API is publicly accessible
  • The API is of type HTTP or SOAP
Nango supports all authorization types (OAuth, API key, basic), including custom ones.

​
Add an API configuration

Fork the repo and edit the API configurations file (providers.yaml). You can test the configuration of your new provider with this command: 
npx tsx scripts/validation/providers/validate.ts

​
Test the API

To test your new provider, go to the nango repo root and run: 
docker compose up
You can modify the ports in the docker-compose.yaml file if there are conflicts with other local services on your host machine.
When you are ready to test your API: Create an integration Open the local Nango UI in your browser and add a new integration with your freshly added API. Create a connection Create a new connection for this API in the Nango UI, completing the authorization flow. Verify the connection If all goes well, you should see your new connection in the Connections tab. Check the connection details and make sure that the credentials are valid.

​
Document the API

Add a <api>.mdx file (e.g. github.mdx) for your API to the docs/integrations/all folder. Check out other examples to fill out the content of the documentation page. Reference the page in the docs/docs.json file in the 700+ APIs & Integrations group in alphabetical order.

​
Submit a pull request

Verify your contribution against examples of past contributions. Submit a pull request with the new provider to the Nango repo. Please thoroughly test the integration! Thanks a lot for your contribution!! ❤️
Questions, problems, feedback? Please reach out in the Slack community.