Skip to content

Commit

Permalink
Merge branch 'main' of github.com:ringcentral/rc-unified-crm-extension
Browse files Browse the repository at this point in the history
  • Loading branch information
DaKingKong committed Oct 29, 2024
2 parents 49155d1 + 8ae4220 commit 763be39
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/developers/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Unified CRM adapter framework currently supports two different authentication modalities:

* [OAuth](#implementing-oauth-for-a-crm). This is the most common form of authentication and authorization supported by most CRMs.
* [OAuth](#connecting-to-a-crm-via-oauth). This is the most common form of authentication and authorization supported by most CRMs.
* [API keys](#connecting-to-a-crm-using-an-api-key). This less common method typically requires a CRM user to retrieve an auth string, often called an "API key," and saving it within the framework. This key is then transmitted with each API request to the CRM.

Start by editing the `platforms` object within your adapter's [manifest](manifest.md), and setting the `type` property under `auth` to either:
Expand Down Expand Up @@ -102,7 +102,7 @@ Within your adapter's `index.js` file, implement the following methods.

Now that the necessary server endpoints have been implemented, and the manifest updated, let's test authorization.

1. Refresh and or save the [Custom CRM config url](../users/settings.md#loading-custom-crm-adapterRefresh) setting under the extension's options.
1. Refresh and or save the [Custom CRM config url](../users/settings.md#loading-custom-crm-adapter) setting under the extension's options.
2. Access the Chrome extension.
3. Log out and log back into your CRM using the "Connect" button under the Settings tab, or by going through the appropriate CRM login and authorization flow for your adapter.
4. Finally, check to see if any user info was saved in the database (`CHECK.1`)
Expand Down
6 changes: 3 additions & 3 deletions docs/developers/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ These basic properties
| Name | Type | Description |
|---------------|--------|-----------------------------------------------------------------------------------------------------------------------|
| `author` | string | The author of the adapter. This is displayed to end users within the Chrome extension. |
| `platforms` | ARRAY of object | An array of [platforms](#platforms-configuration) being integrated with. Each element of this array defines a different CRM. |
| `platforms` | ARRAY of object | An array of [platforms](#platform-configuration) being integrated with. Each element of this array defines a different CRM. |
| `serverUrl` | string | The base URL the Chrome extension will used when composing requests to your adapter. The URL should utilize HTTPS and should omit the trailing slash (`/`). For example: `https://my-adapter.myserver.com` |
| `version` | string | The version of your adapter. This is displayed to end users within the Chrome extension. |

Expand All @@ -37,7 +37,7 @@ The platforms property is an associative array. Each key should be a unique iden
| `name` | string | The name of the CRM. |
| `displayName` | string | The display name of the CRM. |
| `urlIdentifier` | string | The URL for which this CRM will be enabled. When the CRM is enabled for a domain, the extension's orange quick access button will appear. (`*` for wildcard match is supported) |
| `auth` | object | Contains all info for authorization. [Details](#setup-authorization) |
| `auth` | object | Contains all info for authorization. [Details](#authorization) |
| `canOpenLogPage` | boolean | Set to `true` if the corresponding CRM supports permalinks for a given activity/log. When set to `true` users will have the option view/open the activity log in the CRM from the call history page. When set to `false`, users will open the contact page instead. |
| `contactTypes` | ARRAY of object | (Optional) CRMs often adopt unique vernaculars to describe contacts. Provide the enumerated list of contact types supported by the corresponding CRM. Each object has `display` and `value`. |
| `contactPageUrl` | string | A format string to open a CRM's contact page, e.g.`https://{hostname}/person/{contactId}`. Supported parameters: `{hostname}`, `{contactId}`, `{contactType}`|
Expand Down Expand Up @@ -238,4 +238,4 @@ Page fields need to be set to use default values mapped from user settings.
}
}
}
```
```
7 changes: 0 additions & 7 deletions docs/feedback.md

This file was deleted.

Binary file added docs/img/RingCentral_logo_color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ docs_dir: docs

theme:
name: material
logo: img/RingCentral_logo_color.png
font:
code: Roboto Mono
text: Inter Tight
features:
- navigation.path
- navigation.sections
Expand Down

0 comments on commit 763be39

Please sign in to comment.