Download and Deploy a Payload Storage API

Anypoint Partner Manager enables you to configure your own storage solution (for example, a database, Amazon S3, or Azure Blob Storage) to store transmission content.

To use your own storage solution, you must implement an API that provides Partner Manager with a standardized way to connect to your storage.

The payload storage API must be publicly accessible for users to be able to view payload from Partner Manager’s Activity page.

Download and Deploy the Payload Storage API

Before you create your first partner and message flow, you must configure your payload storage API within the host organization in Partner Manager:

  1. Access and download the following APIs from Anypoint Exchange:

  2. Implement the API to connect with your choice of storage location; for example, a database, Amazon S3, or filesystem.

  3. Deploy the API on a runtime that can access the storage solution.

  4. Make a note of the API URL and configuration values:

    • Host, port, and path connection

    • Connection Idle and Response timeouts

    • Authentication types:

      • None

      • API Key

      • Basic

      • Client Credentials

      • OAuth Token

    • Certificate (.PEM format) and connection types

      You’ll need this information when you associate Anypoint Partner Manager with your payload storage API. Your payload storage API must be accessible over the internet via HTTPS. Ensure that the appropriate authentication mechanisms are implemented to enable access over HTTPS.

Add the Payload Storage API to the Host Profile

  1. In Anypoint Platform, open Anypoint Partner Manager.

  2. From the navigation menu, select your organization’s host page.

  3. In the Payload storage section of the page, click Edit to add the path to your payload storage.

  4. Enter the following values:

    • Endpoint name: The name of the payload storage API

    • Description: The optional description for your payload storage

    • URL: The path to your payload storage

      This URL does the following:

      • Stores payloads when transactions process in the runtime

      • Retrieves the payload when you click View Payload on the Transaction Activity page, unless a payload view URL is configured

    • Payload view URL: (Optional) A secondary payload storage API URL that you can use to view the payload on the Activity page if the payload storage API is restricted to your internal network.

      If the payload storage API is not restricted to your internal network, leave this field blank so that you can view the payload by using the View Payload button.

  5. Optionally, if you want to view (or allow your users to view) the raw payloads of the files you receive or send, select Allow users to download payloads.

  6. Click Save.

Change the Payload Storage API Configuration

To change the payload storage API configuration:

  1. In the Payload storage section of the Host page, click Edit.

  2. Modify the field values that require changing.

  3. Click Save.

  4. To have the changes take effect, either redeploy an existing message flow or deploy a new message flow.

Was this article helpful? Thanks for your feedback!
View on GitHub