Skip to end of banner
Go to start of banner

Proxy Endpoints

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Current »

In this article

Overview

Proxy endpoints allow users to access your APIs and third-party APIs. You can define the HTTP methods for your endpoints and apply the appropriate authentication method.

You can:

Endpoint Certificates

Third-party endpoints often have unsigned, self-signed, or expired certificates. Typically, an API will not execute if it encounters a certificate in one of these three statuses. The status of the certificate is beyond the control of an API developer, so if you trust the endpoint, it becomes an inconvenience for the API to fail. Proxies now support the ability to trust all endpoint certificates. You now have the option to choose an endpoint to trust all certificates when you create an endpoint in a Proxy.

SOAP Endpoints

Legacy SOAP services are still prevalent on the web. Enabling SOAP web services in REST APIs provides allows you to take advantage of these services in your REST API endpoints. You can use a Proxy to connect to a SOAP web service and apply API policies against it. In the Create Endpoint dialog, you can easily define parts of the SOAP payload to be dynamically provided by an incoming query parameter or header from the request to execute the Proxy endpoint.

Prerequisites

  • Org Admin permissions

Viewing the List of Endpoints

To view the list of endpoints for a Proxy:

  1. In SnapLogic Manager, go to API Management > API Manager.

  2. In the API Manager, go to the APIs & Proxies tab.

  3. Set Filter by Type to Proxy and click Search.

  4. Click the Proxy's name in the list.

  5. Go to the Proxy Endpoints tab.

Proxy Endpoints tab

Creating an Endpoint

To create an endpoint:

  1. In the API Manager, open a Proxy for editing, then go to the Proxy Endpoints tab.

  2. Click (blue star) to open the Create Proxy Endpoint dialog.

  3. Configure the new endpoint:

Field

Description

Endpoint Name

The name for your proxy's endpoint:

  • Must be unique.

  • Must begin with alphanumeric characters A-Z, a-z, or 0-9.

  • Cannot contain the reserved keyword shared.

  • Cannot contain the following characters:
    | < > [ ] { } # ? / \

  • Must be no more than 256 characters. If the name includes double-byte characters, the maximum length is shorter.

URL

The URL to which users send their requests.

Example: https://www.example.com/path/to/the/api

HTTP Method(s)

One or more REST methods for the API that this endpoint will service.

  • Get

  • Put

  • Head

  • Post

  • Patch

  • Delete

Trust all Certificates

Select this checkbox to run the API calls regardless of the certificate status. If you leave this checkbox deselected (default setting), any endpoint with an expired or unsigned certificate will fail the API call.

REST to SOAP

Select this checkbox to enable a SOAP payload as a REST HTTP call. When selected, the SOAP payload filed appears. The derfault setting is unselected.

The REST to SOAP checkbox only supports incoming GET requests by default. The HTTP method cannot be modified and will always call the SOAP endpoint with a POST.

Example of a valid SOAP payload:

<?xml version="1.0"?>

<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope/"
soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">

<soap:Body>
  <m:GetPriceResponse xmlns:m="https://www.w3schools.com/prices">
    <m:Price>UnitPrice</m:Price>
  </m:GetPriceResponse>
</soap:Body>

</soap:Envelope>

Instead of a static value for Price, you can insert a key, such as UnitPrice, where the value can be defined from the request. The endpoint https://snaplogic.io/gateway/MyProxy/MyProxyEndpoint?UnitPrice=10.99 would be replaced in the payload at runtime as 10.99 instead of UnitPrice or a static value.

Editing an Endpoint

To edit an endpoint:

  1. In the API Manager, open a proxy for editing, then go to the Proxy Endpoints tab.

  2. Click the endpoint's name in the list.

    Edit Proxy Endpoint

    Learn more: Proxy Endpoint Details.

  3. To edit the proxy details, click the Edit Details button.

    Note: You can update only the URL and HTTP Method(s) of the endpoint.

  4. To apply security policies to the endpoint, click the plus icon ( (blue star) ) below the View Applied Policies button.

Deleting an Endpoint

To delete an endpoint:

  1. In the API Manager, open a proxy for editing, then go to the Proxy Endpoints tab.

  2. Check the box for the endpoint to delete.

  3. Click the trash icon ( (blue star) ). The Delete confirmation message appears:

  4. Click Delete.

  5. Verify the deleted Assets by navigating to the Manager Recycle Bin for your Org.

  6. To delete forever:

    1. Select the endpoint.

    2. Click (blue star) to delete it permanently from the Manager Recycle Bin.

  • No labels