Skip to content

Commit 242e526

Browse files
committed
DOC-3151: Refine cloud troubleshooting documentation for invalid API key errors.
1 parent 99926c3 commit 242e526

File tree

1 file changed

+29
-36
lines changed

1 file changed

+29
-36
lines changed

modules/ROOT/pages/cloud-troubleshooting.adoc

Lines changed: 29 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ When {cloudname} detects a problem, it will show an editor notification containi
88
NOTE: The wording of the notifications shown here may differ from the actual notifications from {cloudname}.
99

1010
'''
11-
1211
[[invalid-api-key-cloud-troubleshooting]]
1312
== Invalid API Key
1413

@@ -17,63 +16,57 @@ NOTE: The wording of the notifications shown here may differ from the actual not
1716

1817
==== Cause
1918

20-
This notification is *only shown* when either:
19+
This notification is shown when either:
20+
21+
* An `+apiKey+` is not provided in the script tag,
22+
* An empty or missing `+apiKey+` is provided, or
23+
* The `+apiKey+` provided cannot be found on the {cloudname} server.
24+
25+
The `+apiKey+` must be:
2126

22-
. An `+apiKey+` is not provided in the script tag.
23-
. An empty `+apiKey+`.
27+
* An exact length,
28+
* comprised of certain characters, and
29+
* created with a {cloudname} account on the link:{accountsignup}/[{accountpage} page].
2430

2531
For example:
2632

2733
[source,html,subs="attributes+"]
2834
----
29-
<script src="{cdnurl}" referrerpolicy="origin"></script>
35+
<script src="https://cdn.tiny.cloud/1/abcd1234/tinymce/{productmajorversion}/tinymce.min.js" referrerpolicy="origin"></script>
3036
----
3137

38+
In this case, the editor will be in a **read-only** state, and the user will see a **"Finish setting up"** dialog prompting them to add a valid API key, configure their domain, and explore premium features.
39+
3240
==== Solution
3341

34-
Update the `+src+` URL to include your (website or application developer's) {cloudname} API Key. Your API key should replace the string `+no-api-key+`.
42+
To resolve this issue:
3543

44+
. Update the `+src+` URL to include your (website or application developer's) {cloudname} API Key, by replacing the placeholder `+no-api-key+` with your actual API key.
45+
+
3646
For example: if your API is `+abcd1234+`:
37-
47+
+
3848
[source,html,subs="attributes+"]
3949
----
4050
<script src="https://cdn.tiny.cloud/1/abcd1234/tinymce/{productmajorversion}/tinymce.min.js" referrerpolicy="origin"></script>
4151
----
52+
+
53+
. Check the `+apiKey+` provided in the script tag:
54+
* Remove any leading or trailing spaces.
55+
* Remove any other characters that are not in your `apiKey`. If you are using variable substitution, ensure that the variable is substituting properly.
56+
* Ensure the `apiKey+` matches the API key shown at {accountpageurl}.
57+
+
58+
. If you do not have an API key, or need to retrieve your existing key, visit: link:{accountsignup}/[{cloudname}].
4259

43-
To retrieve your API key, or to sign up for an API key, visit: link:{accountsignup}/[{cloudname}].
44-
45-
NOTE: Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix a `invalid API key` with {productname}.
46-
47-
In this case, the editor will be in a **read-only** state, and the user will see a **"Finish setting up"** dialog prompting them to add a valid API key, configure their domain, and explore premium features.
60+
[NOTE]
61+
Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix an `invalid API key` issue with {productname}.
4862

49-
[[placeholder]]
50-
=== "placeholder[Click here to learn more.]"
51-
52-
==== Cause "Invalid API Key"
53-
54-
This notification is shown when the API key provided cannot be found on the {cloudname} server.
55-
56-
The `+apiKey+` must be:
57-
58-
* An exact length,
59-
* comprised of certain characters, and
60-
* created with a {cloudname} account on the link:{accountsignup}/[{accountpage} page].
61-
62-
==== Solution
63-
64-
Check the `apiKey` provided in the script tag:
65-
66-
* Remove any leading or trailing spaces
67-
* Remove any other characters that are not in your `apiKey`. If you are using variable substitution, ensure that the variable is substituting properly
68-
* Ensure the `apiKey` matches the API key shown at {accountpageurl}.
69-
70-
NOTE: Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix a `invalid API key` with {productname}.
63+
'''
7164

7265
[[no-api-key-cloud-troubleshooting]]
7366
== No API Key
7467

7568
[[A-valid-API-key-is-required-to-continue-using-TinyMCE.]]
76-
=== "A valid API key is required to continue using TinyMCE.[]"
69+
=== "A valid API key is required to continue using {productname}." (Console message)
7770

7871
==== Cause
7972

@@ -83,7 +76,7 @@ image:onboarding/onboarding-finish-setting-up-dialog.png[onboarding finish setti
8376

8477
==== Solution
8578

86-
Update the `+src+` URL to include your (website or application developer's) {cloudname} API Key. Your API key should replace the string `+no-api-key+`.
79+
. Update the `+src+` URL to include your (website or application developer's) {cloudname} API Key, by replacing the placeholder `+no-api-key+` with your actual API key.
8780

8881
For example: if your API is `+abcd1234+`:
8982

0 commit comments

Comments
 (0)