W-17246664 Enabling API Catalog #373
Conversation
| @@ -0,0 +1,33 @@ | |||
| = Enabling API Catalog | |||
|
|
|||
| Enable a connected Salesforce organization to access and sync Anypoint Platform APIs into the Salesforce API Catalog and expose them as invocable actions. This capability is enabled in Anypoint Platform Access Management by an Anypoint Platform organization administrator. | |||
There was a problem hiding this comment.
| Enable a connected Salesforce organization to access and sync Anypoint Platform APIs into the Salesforce API Catalog and expose them as invocable actions. This capability is enabled in Anypoint Platform Access Management by an Anypoint Platform organization administrator. | |
| Enable a connected Salesforce organization to access and sync Anypoint Platform APIs into API Catalog in Salesforce. This capability is enabled in Anypoint Platform Access Management by an Anypoint Platform organization administrator. |
There was a problem hiding this comment.
Let's ask Ankita Darda (PM) about the level of detail we want to add. I'd suggest leaving off the details about what they can do once the APIs are in API Catalog and handle that in the API Catalog UI text and Help content. There's still some contention about what to call actions (invocable actions or just actions like the ASCX team does) and if we talk about those, we probably want to talk about topic and agent actions, which gets a little long.
The naming is a little awkward, but it's not called Salesforce API Catalog right now. It's API Catalog in Salesforce. Again, this would be a PM question. Also, we shouldn't use "the API Catalog", since API Catalog is a proper noun.
| include::partial$include-nav-steps-org-admin.adoc[] | ||
|
|
||
| . Click *Salesforce*. | ||
| . In *Capabilities Managed in Anypoint Platform*, click *Settings* for *Make MuleSoft Anypoint Platform APIs Available in Salesforce*. |
There was a problem hiding this comment.
Right now these options don't seem to match what's in QAX. Is there a new design for this I should be using for the review?
| . In *Settings*, select the Anypoint Platform business groups that allow the Salesforce organization to import Anypoint Platform APIs into its API Catalog, and click *Save Settings*. | ||
| + | ||
| [NOTE] | ||
| Within the selected business groups, you can import only APIs that have specs published in Exchange with active instances into Salesforce. |
There was a problem hiding this comment.
There are quite a prerequisites that have to be met for APIs to sync into API Catalog. I wonder if we could be a little less specific here and cross-reference the API Catalog "Before You Begin" (Name and link tbd) content in help.salesforce.com? Something like:
Within the selected business groups, you can sync only APIs from Exchange that have managed instances and meet the prerequisite conditions. For more information, see Salesforce Help.
The alternative might be to duplicate all of the prereqs here, which becomes a maintenance issue. It's a bit of a moving target now.
There was a problem hiding this comment.
Also, import should be changed to sync throughout the content and the UI text.
| + | ||
| The Salesforce organization administrator can then sync APIs into their catalog. | ||
| + | ||
| For details about syncing APIs and using API Catalog in Salesforce, see xref:general::api-catalog-in-salesforce.adoc[]. |
There was a problem hiding this comment.
Will this link be replaced with a link to the topic in Salesforce Help? I have the planned link, but need to get the topic ID approved by a content strategist before I share it.
| The Salesforce organization administrator can then sync APIs into their catalog. | ||
| + | ||
| For details about syncing APIs and using API Catalog in Salesforce, see xref:general::api-catalog-in-salesforce.adoc[]. | ||
| . After the APIs are synced, the Salesforce administrator selects individual API instances and operations and converts them into invocable actions so Salesforce developers can access them. |
There was a problem hiding this comment.
I wonder if we're trying to document too much about API Catalog here? I recommend cross-referencing the API Catalog content in Salesforce Help here as well and simplifying to something a little less specific. I should have something for review by next sprint and we can put our heads together then on what makes sense to cover her for the Access Management admin.
| For details about syncing APIs and using API Catalog in Salesforce, see xref:general::api-catalog-in-salesforce.adoc[]. | ||
| . After the APIs are synced, the Salesforce administrator selects individual API instances and operations and converts them into invocable actions so Salesforce developers can access them. | ||
| + | ||
| A client ID is created. |
There was a problem hiding this comment.
We might want to have Yining Zhao and/or Mariana Zurita review this. Salesforce admins create connections for the API instances either as part of activating actions or for existing actions, and these connections handle the authentication between Anypoint Platform and Salesforce based on credentials and permission sets. The Salesforce admin adds users (here called Salesforce developers) to permission sets. API Catalog can detect through the connection functionality when access needs to be requested, when access is rejected or revoked, and when a client contract has been deleted. API Catalog also has options for selecting SLA tiers. I'm still getting familiar with the details on this.
Writer's Quality Checklist
Before merging your PR, did you: