Contact Us 1-800-596-4880
  1. Homepage
  2. Partner Manager (2.x)
  3. Message Flow Components
  4. Endpoints
  5. Receive Endpoints

  6. HTTP and HTTPS Receive Endpoint Settings

HTTP and HTTPS Receive Endpoint Settings

HTTP and HTTPS receive endpoints configure where to receive B2B messages transmitted over HTTP or HTTPS, respectively. There are two type of HTTP and HTTPS endpoints:

  • Receive from Partners

    Source endpoint in an inbound message flow that receives inbound B2B messages from partners either directly or via third-party connections.

    A host, partner, or third-party connection can own HTTP and HTTPS Receive from Partners endpoints.

  • Source at Host

    Source endpoint in an outbound message flow that receives application messages from the backend applications

    Only a host can own HTTP or HTTPS Source at Host endpoints.

Each HTTP and HTTPS receive endpoint configuration gets deployed as an individual Mule application in the runtime. To minimize the number of vCores needed to run Anypoint Partner Manager, use an existing HTTP or HTTPS receive endpoint configuration across multiple message flows.

Create HTTP and HTTPS receive endpoints by configuring these settings on the <host> page:

Name Description Required

Endpoint Name

Automatically generated name used to identify the endpoint, which you can modify manually.

x

Owner

Host, partner, or third-party connection that owns the endpoint.

x

Usage

Endpoint function (Receive from partners or Source at host).

x

Protocol

Protocol that the endpoint supports (HTTP or HTTPS).

x

Description

User-supplied value that describes the purpose of the endpoint.

Private port (when deploying to VPC)

Applies when using Anypoint Virtual Private Cloud (Anypoint VPC) with CloudHub deployments:

  • When enabled, the AS2 receive endpoint application deploys to the private port 8092 in your Anypoint VPC. You can manage the access control to the endpoint via the Anypoint VPC and dedicated load balancer settings.

  • When disabled, the AS2 receive endpoint application deploys to the public port 8082 by default.

    You can access the endpoint URL directly over the internet.

Manage with API Manager

Enable this setting to manage the endpoint, including its access control, with API Manager. When you manage an endpoint with API Manager, you can apply various policies, including authentication and client credentials, and you can configure SLA tiers for the endpoint. You can also leverage Anypoint Exchange to document your message specifications and share them with your partners via public portals by leveraging Anypoint API Experience Hub. (This requires an additional license.)

To have an endpoint managed with API Manager, create an HTTP API in API Manager in the same environment and organization as the endpoint.

When you create this API in API Manager:

  • Select HTTP API as the asset type.

  • Leave the defaults on the Endpoint configuration screen.

  • Copy the API instance ID and paste it into the API Auto discovery id field in the Partner Manager New endpoint: Receive from Partners window.

Using this feature requires an API Manager license.

HTTPS

Applies to CloudHub deployments.

Indicates whether Partner Manager deploys this endpoint as an HTTPS or HTTP listener:

  • If enabled (default), Partner Manager deploys this endpoint as an HTTPS listener.

  • If disabled, Partner Manager deploys this endpoint as an HTTP listener.

When deploying to Anypoint Runtime Fabric, Partner Manager always deploys this endpoint as an HTTP listener. With this type of deployment, you must configure an Ingress controller to provide external consumers with an HTTPS endpoint. For more information, see Configuring Ingress for Runtime Fabric.

x

URL

HTTP or HTTPS address where you receive outbound source messages from backend applications or inbound B2B messages from your partners. Partner Manager automatically generates this ID after the first message flow that uses the endpoint is deployed.

x

Response timeout (in milliseconds)

Response timeout period in milliseconds. The default is 15000.

x

Authentication type

Authentication method used to protect the HTTP or HTTPS endpoint. This field is disabled when you manage the endpoint with API Manager.

Valid values are:

x

API Key Authentication

Authentication type that requires a valid API key in the HTTP request header.

Use the following settings to configure API Key authentication:

Name Description Required

HTTP Header Name

HTTP header parameter associated with the API key value.

x

API Key

Value of the API key.

After saving your new or reconfigured endpoint, you cannot subsequently retrieve or modify the API key.

x

Certificate

Certificate to use for authentication.

Basic Authentication

Authentication type that requires a username and password in the HTTP or HTTP request header.

Use the following settings to configure Basic authentication:

Name Description Required

Username

Username to use when making a request.

x

Password

Password to use when making a request.

x

Next Step

After you create an HTTP or HTTPS receive endpoint, you can deploy it, as described in Deploying AS2, HTTP, and HTTPS Receive Endpoints.

See Also