-
Notifications
You must be signed in to change notification settings - Fork 452
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
<!-- Describe the problem and your solution --> Updates our docs for integrations to be in the new format described in [the ticket](https://linear.app/nango/issue/NAN-2320/backfill-api-specific-docs ). We're leaning on Mintlify snippets for the always generated portions of the document. See `scripts/docs-gen-snippets.mjs` for that. <!-- Issue ticket number and link (if applicable) --> https://linear.app/nango/issue/NAN-2320/backfill-api-specific-docs <!-- Testing instructions (skip if just adding/editing providers) --> ## How I tested it - Run `npm run docs` - Click through the updated documents and make sure everything looks right --------- Co-authored-by: Bastien Beurier <bastienbeurier@gmail.com>
- Loading branch information
1 parent
ef33847
commit a3035df
Showing
615 changed files
with
28,295 additions
and
3,650 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,90 @@ | ||
| --- | ||
| title: Acuity Scheduling | ||
| sidebarTitle: Acuity Scheduling | ||
| provider: acuity-scheduling | ||
| --- | ||
| import Overview from "/snippets/overview.mdx"; | ||
|
|
||
| API configuration: [`acuity-scheduling`](https://nango.dev/providers.yaml) | ||
| import PreBuiltUseCases from "/snippets/generated/acuity-scheduling/PreBuiltUseCases.mdx" | ||
|
|
||
| ## Features | ||
| <Overview /> | ||
|
|
||
| | Features | Status | | ||
| ## Pre-built tooling | ||
|
|
||
| <AccordionGroup> | ||
| <Accordion title="✅ Authorization"> | ||
| | Tools | Status | | ||
| | - | - | | ||
| | Pre-built authorization (OAuth) | ✅ | | ||
| | Credentials auto-refresh | ✅ | | ||
| | Auth parameters validation | Not needed | | ||
| | Credentials validation | Not needed for OAuth | | ||
| | Pre-built Connect UI | ✅ | | ||
| | Custom authorization UI | ✅ | | ||
| | End-user authorization guide | Not needed for OAuth | | ||
| | Expired credentials detection | ✅ | | ||
| </Accordion> | ||
| <Accordion title="✅ Read & write data"> | ||
| | Tools | Status | | ||
| | - | - | | ||
| | Pre-built use-cases | 🚫 (time to contribute: <48h)]) | | ||
| | API unification | ✅ | | ||
| | 2-way sync | ✅ | | ||
| | Webhooks from Nango on data modifications | ✅ | | ||
| | Real-time webhooks from 3rd-party API | ✅ | | ||
| | Proxy requests | ✅ | | ||
| </Accordion> | ||
| <Accordion title="✅ Observability & data quality"> | ||
| | Tools | Status | | ||
| | - | - | | ||
| | HTTP request logging | ✅ | | ||
| | End-to-type type safety | ✅ | | ||
| | Data runtime validation | ✅ | | ||
| | OpenTelemetry export | ✅ | | ||
| | Slack alerts on errors | ✅ | | ||
| | Integration status API | ✅ | | ||
| </Accordion> | ||
| <Accordion title="✅ Customization"> | ||
| | Tools | Status | | ||
| | - | - | | ||
| | [Auth (OAuth)](/guides/getting-started/authorize-an-api-from-your-app) | ✅ | | ||
| | [Sync data](/guides/getting-started/read-from-an-api) | ✅ | | ||
| | [Perform workflows](/guides/getting-started/write-to-an-api) | ✅ | | ||
| | [Proxy requests](/guides/proxy-requests-to-an-api) | ✅ | | ||
| | [Receive webhooks](/guides/receive-webhooks-from-an-api) | 🚫 (time to contribute: <48h) | | ||
| | Create or customize use-cases | ✅ | | ||
| | Pre-configured pagination | ✅ | | ||
| | Pre-configured rate-limit handling | ✅ | | ||
| | Per-customer configurations | ✅ | | ||
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| <PreBuiltUseCases /> | ||
|
|
||
| ## Access requirements | ||
| | Pre-Requisites | Status | Comment| | ||
| | - | - | - | | ||
| | Paid dev account | ❓ | | | ||
| | Paid test account | ❓ | | | ||
| | Partnership | ❓ | | | ||
| | App review | ❓ | | | ||
| | Security audit | ❓ | | | ||
|
|
||
|
|
||
| <Tip>We can implement missing features in <48h, just ask for it in the [community](https://nango.dev/slack).</Tip> | ||
| ## Setup guide | ||
|
|
||
| ## Getting started | ||
| _No setup guide yet._ | ||
|
|
||
| <Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip> | ||
|
|
||
| <Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/acuity-scheduling.mdx)</Note> | ||
|
|
||
|
|
||
| ## Useful links | ||
|
|
||
| - [How to register an Application](https://acuityscheduling.com/oauth2/register) | ||
| - [OAuth-related docs](https://developers.acuityscheduling.com/docs/oauth2) | ||
| - [API](https://developers.acuityscheduling.com/reference/quick-start) | ||
|
|
||
| <Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip> | ||
| <Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/acuity-scheduling.mdx)</Note> | ||
|
|
||
| ## API gotchas | ||
| - Acuity uses OAuth for authentication. Ensure you have the correct client ID and secret. | ||
| - Acuity Scheduling enforces a general rate limit of 10 requests a second and 20 concurrent connections from an IP. | ||
|
|
||
| <Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/acuity-scheduling.mdx)</Note> | ||
| <Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/acuity-scheduling.mdx)</Note> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.