Contact Free trial Login

Payload Storage API for Partner Manager

Anypoint Partner Manager enables you to configure your own storage solution, such as database, Amazon S3, Azure Blob Storage, and so on to store transmission content, such as incoming and outgoing B2B message payloads.

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

To store your content, you must implement an API that provides Anypoint Partner Manager with a standardized way to connect to your unique storage.

Download and Deploy the Payload Storage API

Follow these steps to set up the payload storage API:

  1. Download these APIs from Anypoint Exchange:

    Partner Manager Content Storage API - S3 Template (sample implementation template)

  2. Implement the API to connect with your choice of storage location (S3, Database, File System, and so on).

  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.

Configure the Payload Storage API

  1. In Anypoint Platform, open Anypoint Partner Manager.

  2. In the navigation menu on the left, select your organization’s profile (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 Name for the payload storage API

    • Description Optional description for your payload storage

    • URL
      Path to your payload storage

  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.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub