Skip to content

[CON-3451] feat: add monaco provider guide #687

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.

Sign up for GitHub

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

Open
Jkarage wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[CON-3451] feat: add monaco provider guide #687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions src/generate-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
42 changes: 42 additions & 0 deletions src/provider-guides/monaco.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading