Skip to content

api-catalog-in-salesforce.adoc

Latest commit

 

History

History
200 lines (142 loc) · 11.5 KB

api-catalog-in-salesforce.adoc

File metadata and controls

200 lines (142 loc) · 11.5 KB

API Catalog in Salesforce

From Anypoint Exchange to Service Mesh and API Governance, MuleSoft helps API-producing teams create well-documented, governed, and secure APIs. Integrations between MuleSoft Anypoint Platform and Salesforce enable you to access and bring MuleSoft APIs into Salesforce.

API Catalog in Salesforce provides a single place for you to view your MuleSoft APIs in Salesforce and improves connection management by simplifying and automating some of the steps to create secure connections to MuleSoft API instances. With API Catalog in Salesforce you can:

  • Import managed MuleSoft APIs into Salesforce.

  • View a catalog of MuleSoft APIs available for use in Salesforce.

  • Sync to get the latest changes and updates.

  • Activate operations from Anypoint APIs as Salesforce invocable actions.

Consider a scenario where you want to connect Salesforce to a credit service API that has an API that’s managed in Anypoint Platform. The credit service retrieves the customer’s credit score, determines whether the customer qualifies for the credit service, and provides the payment terms. You want to extend the credit service to a Salesforce account so that you can view the payment terms in Salesforce.

You can bring the credit service API into API Catalog in Salesforce, select operations and activate them as actions, and then use them in Flow Builder automations.

Before You Begin

Work with an Anypoint Platform admin to ensure that they complete all prerequisite configuration in the Anypoint Platform organization so that you can sync APIs. The prerequisites to using API Catalog in Salesforce are:

  • A valid MuleSoft Anypoint Platform account. See access-management::managing-your-account.adoc.

  • API specs in MuleSoft Anypoint API Exchange that you want to import into API Catalog. See exchange::index.adoc.

  • A tag of sf-api-catalog in Anypoint Exchange on each API you want to import. See Add and Remove Asset Tags.

  • Instances of your APIs in API Manager with either no SLA tiers or at least one auto-approval SLA tier. See api-manager::add-api-instances.adoc.

  • A consumer endpoint for each instance with an HTTPS URL that specifies a proxy application’s address for consumers to use for sending requests. Consumer URLs appear as destination URLs in API Catalog. To configure a consumer endpoint for Mule Gateway API instances, see api-manager::create-instance-task-mule.adoc.

  • An Anypoint Platform and Salesforce org connection established and the API Catalog feature enabled in Anypoint Platform Access Management. See access-management::connecting-salesforce-orgs.adoc.

    Tip
    		 Salesforce admins get the connection information the Anypoint Platform admin needs, such as the Salesforce tenant key of the Salesforce org, and enable MuleSoft features in their Salesforce org Setup in MuleSoft > Anypoint Platform Setup.

Get Started with API Catalog in Salesforce

High level steps of using API Catalog in Salesforce

  1. Work with Anypoint Platform admins to establish a trusted connection between Anypoint Platform and Salesforce and enable the API Catalog feature in Access Management.

  2. Sync eligible APIs into API Catalog in Salesforce.

  3. View and search APIs in the catalog for easier discovery.

  4. Activate actions for specific API operations, which autogenerates secure connection configurations for each action.

  5. Assign user permissions for each connection’s permission set to ensure that Salesforce users have the correct access.

  6. Start using the actions in a Flow Builder flow.

Sync API Catalog

Sync API Catalog to initially populate the catalog with MuleSoft APIs and when you have new or updated APIs that you want to bring into the catalog. This retrieves the latest information from Anypoint Platform.

To sync API Catalog:

  1. Work with an Anypoint Platform admin to ensure that all prerequisite configuration is done in the Anypoint Platform organization from which you want to sync APIs.

  2. In Salesforce, from Setup, in the Quick Find box, enter API Catalog and select it.

  3. Click Sync APIs.

    The sync imports APIs into API Catalog that have:

    • A tag of sf-api-catalog in Anypoint Exchange

    • Instances in API Manager with either no SLA tiers or at least one auto-approval SLA tier

    • A consumer endpoint with an HTTPS URL

Note
 The sync might take several minutes to complete. You can navigate away from the API Catalog page and the sync continues in the background.

Refresh API Catalog

Refresh when you navigate away from the API Catalog page and aren’t sure you have the latest information from your most recent sync. This retrieves the latest information from the Salesforce database.

To refresh the API Catalog page with the latest synced API information:

  1. From Setup, in the Quick Find box, enter API Catalog and select it.

  2. Click the refresh icon.

View and Search APIs in API Catalog

After you populate API Catalog, you can view and search the list to find APIs you want to use in Salesforce.

API Catalog in Salesforce with a list of APIs

Activate Actions

When you select an API in your API Catalog API list, you can activate actions for API operations to use in your automations, such as those in Flow Builder. The activate actions process begins the create connection process that automatically generates the authentication configuration objects for the APIs.

You can activate actions only for the latest API version. If earlier versions already have activated actions, you can view their operations selections and connections. See View Details for an API Version.

To activate actions:

  1. From Setup, in the Quick Find box, enter API Catalog and select it.

    If you have an active connection to an Anypoint Platform organization, API Catalog shows the list of APIs imported from Anypoint Exchange. If you don’t see any APIs, see Sync API Catalog.

  2. Select the API you want to activate actions for.

    1. View resource names for operations that are generated from the automatically-imported API schema.

    2. Expand the rows to view operation names and descriptions.

  3. Click Activate Actions.

  4. Select operations to activate as actions and then click Next.

  5. In the Create Connection page, create a connection to authorize the use of activated actions in Salesforce for a destination URL.

    The connection name defaults to the API name and version.

    1. Overtype the name to customize it.

    2. Enter a description.

  6. Select a destination URL to use as the managed named credential for this connection to Salesforce. API Catalog lists only active destination URLs, which are managed in Anypoint API Manager.

  7. Click Done.

    The Create Connection process creates the required objects in Salesforce automatically, including:

    • External credentials

    • Named credentials

    • External Services

    • Invocable Actions

    • Permission Sets

The UI prompts you to allow access to actions and gives a link to the connection’s permission set in Salesforce Setup.

Assign User Permissions for Connections

After you create the connection, give specific Salesforce users access to the activated actions so that they can use them in their Salesforce automations.

Click the permission sets link on a connection’s details page to go to the permission set for that connection.

For details on assigning user permissions in permission sets for connections, see Manage Permission Set Assignments.

The actions are now available for those users to select and use in Flow Builder automations.

Manage Activated Actions and Connections

To manage activated actions and connections, you can:

  • View operation selections and connection information for all versions of your APIs that have them.

  • Modify operation selections.

  • Modify connection descriptions.

  • Delete connections.

View Details for an API Version

API Catalog shows the versions of an API that meet the criteria for syncing with API Catalog. The UI shows information for the latest version by default.

To view Connections for an API version:

  1. From Setup, in the Quick Find box, enter API Catalog and select it.

  2. Select an API.

  3. Switch between versions in the API Version menu to see the operations and connections associated with that version.

Edit Operation Selections

To modify the operation selections for activated actions:

  1. From Setup, in the Quick Find box, enter API Catalog and select it.

  2. Select the API to modify the operation selections for.

  3. In the Connections tab, click Edit.

  4. Select or deselect operations.

Edit Connection Descriptions

To modify a connection description:

  1. From Setup, in the Quick Find box, enter API Catalog and select it.

  2. Select the API to modify the connection description for.

  3. In the Connections tab, click Edit.

  4. Click Next on the Operations page.

  5. Update the connection description.

Note
 You can’t change the connection name and destination URL because they’re used to name and later identify auto-generated configurations.

Get Started Using MuleSoft APIs as Actions in Flows

After you sync your APIs in API Catalog and activate operations as actions, you can get started using them in a Flow Builder flow. An example is to create a flow for the scenario discussed at the beginning of this document, connecting Salesforce to a credit service API that has a managed API instance in Anypoint Platform.

The credit service retrieves the customer’s credit score, determines whether the customer qualifies for the credit service, and provides the payment terms. You want to extend the credit service to a Salesforce account so that you can view the payment terms in Salesforce.

After you populate API Catalog in Salesforce, you can:

  1. Find and select the credit service API‌ in API Catalog in Salesforce.

  2. Select the operations that you want to make available in Salesforce as invocable actions and create connections for them.

    The create connection process automatically generates the credentials for invoking the API actions from within Salesforce automations.

  3. Enable the permission set created for the activated API’s connection.

After you activate the invocable actions from API Catalog, you can use Flow Builder to use the actions in your automations.

  1. Create a flow using the new credit service API category in Flow Builder.

    When the flow runs, the output contains the credit decision and, if applicable, payment terms.

See Also
⚡