Skip to content
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.

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

Create miradore.md #544

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

Create miradore.md #544

wants to merge 1 commit into from

Conversation

edumare77
Copy link
Contributor

No description provided.

Comment on lines +13 to +20
### Create API Key
1. Login into your Miradore account
2. Start by navigating into System > Infrastructure diagram in Miradore's Navigation menu.
3. In the infrastructure diagram, you should see a grey API icon indicating that the API has not yet been activated. Hover on the icon, and click the Activate button.
4. Wizard for activating the API should appear on top of the page. In the first step of the wizard, read the acknowledgment and tick the checkbox. Once you're done you can proceed by clicking Activate now.
5. After successful activation, the icon of the API should turn blue. Hover on the blue icon, and click Create key in order to generate an authentication key for the API.
6. In the next step, you are asked to enter a name for the API authentication key. This is important especially if you are going to create multiple authentication keys to be used with different information systems.
7. Next, create the API key. Write it down in a secure place, for security reasons, it cannot be seen from the Miradore user interface afterward.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Create API Key
1. Login into your Miradore account
2. Start by navigating into System > Infrastructure diagram in Miradore's Navigation menu.
3. In the infrastructure diagram, you should see a grey API icon indicating that the API has not yet been activated. Hover on the icon, and click the Activate button.
4. Wizard for activating the API should appear on top of the page. In the first step of the wizard, read the acknowledgment and tick the checkbox. Once you're done you can proceed by clicking Activate now.
5. After successful activation, the icon of the API should turn blue. Hover on the blue icon, and click Create key in order to generate an authentication key for the API.
6. In the next step, you are asked to enter a name for the API authentication key. This is important especially if you are going to create multiple authentication keys to be used with different information systems.
7. Next, create the API key. Write it down in a secure place, for security reasons, it cannot be seen from the Miradore user interface afterward.
### Create an API Key
1. Login into your Miradore account
2. From the navigation menu, select **System > Infrastructure diagram**.
3. Locate the grey API icon, this indicates the API has not yet been activated. Hover your cursor over it and select **Activate**. The API activation wizard will appear at the top of the page.
4. In the API activation wizard, read the acknowledgment and select the checkbox.
5. Select **Activate now**.
6. If successful, the API icon should turn blue. Hover your cursor over it and select **Create key**.
7. Enter a name for the API key. This must be done as API keys are identified by their name. Setting a unique name allows for multiple API keys.
8. Select **Create API key** to create an API key.
Make note of the API key in a secure place. For security reasons, it cannot be seen from the Miradore interface after creation.

Rewrite to remove unnecessary words. Update formatting.

Comment on lines +31 to +49
To set up the Miradore connector in Cyclr, go to your Cyclr console:

1. Go to **Connectors** > **Application Connector Library**.

2. Use the search box to find the Miradore connector.

3. Select the **Setup Required** icon.

4. Enter the Sub Domain then click Next. Then enter API key and the API secret, they have to be joined by a colon (e.g. key:secret):

| **Value** | **Description** |
| :----------------- | :------------------------------------------------------------------------------ |
| **Site Name** | The name of your site. |
| **API Key** | The API key from the Parter Connect subscription email. |


5. Select **Save Changes**.

> **Note**: If you leave any values blank, Cyclr asks for the value when you install the connector into an account. This means you can use different settings for different accounts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To set up the Miradore connector in Cyclr, go to your Cyclr console:
1. Go to **Connectors** > **Application Connector Library**.
2. Use the search box to find the Miradore connector.
3. Select the **Setup Required** icon.
4. Enter the Sub Domain then click Next. Then enter API key and the API secret, they have to be joined by a colon (e.g. key:secret):
| **Value** | **Description** |
| :----------------- | :------------------------------------------------------------------------------ |
| **Site Name** | The name of your site. |
| **API Key** | The API key from the Parter Connect subscription email. |
5. Select **Save Changes**.
> **Note**: If you leave any values blank, Cyclr asks for the value when you install the connector into an account. This means you can use different settings for different accounts.
Cyclr asks you for the below values when you install the Miradore connector into an account:
| **Value** | **Description** |
| :------------ | :------------------------------------------------------- |
| **Site Name** | The name of your site. |
| **API Key** | The API key from the Partner Connect subscription email. |
> **Note**: You can use different details for different accounts.

This has the formatting of partner level parameters when they're account level. Changed to reflect this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants