diff --git a/src/docs.json b/src/docs.json index ab0120ee..80de3454 100644 --- a/src/docs.json +++ b/src/docs.json @@ -198,6 +198,7 @@ "provider-guides/miro", "provider-guides/mixmax", "provider-guides/mixpanel", + "provider-guides/monaco", "provider-guides/monday", "provider-guides/mural", "provider-guides/netsuite", diff --git a/src/generate-docs.ts b/src/generate-docs.ts index 8f39d6f9..487d8a24 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -430,6 +430,7 @@ const baseConfig = { "provider-guides/miro", "provider-guides/mixmax", "provider-guides/mixpanel", + "provider-guides/monaco", "provider-guides/monday", "provider-guides/mural", "provider-guides/netsuite", diff --git a/src/provider-guides/monaco.mdx b/src/provider-guides/monaco.mdx new file mode 100644 index 00000000..82c17dcf --- /dev/null +++ b/src/provider-guides/monaco.mdx @@ -0,0 +1,42 @@ +--- +title: Monaco +--- +## What's supported + +### Supported actions + +This connector supports: +- [Proxy Actions](/proxy-actions), using the base URL `https://api.monaco.com`. + +### Example integration + +To define an integration for Monaco, create a manifest file that looks like this: + +```YAML +# amp.yaml +specVersion: 1.0.0 +integrations: + - name: monaco-integration + displayName: My Monaco Integration + provider: monaco + proxy: + enabled: true +``` + +## Using the connector + +This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) + +To start integrating with Monaco: +- Create a manifest file like the example above. +- Deploy it using the [amp CLI](/cli/overview). +- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for an API key. +- Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the API key supplied by the customer. Please note that this connector's base URL is `https://api.monaco.com`. + +## Creating an API key for Monaco + +1. Log in to your Monaco account. +2. Navigate to **Settings** and select **API Keys**. +3. Create a new key and copy its value. Monaco API keys are prefixed with `mks_`. + +[Click here](https://docs.monaco.com/auth) for more information about generating an API key for Monaco. The UI components will display this link, so that your users can successfully create API keys.