Versions Compared

Version Old Version 12 New Version Current
Changes made by

John Brinckwirth

John Brinckwirth

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This article describes various sets of best practices for using SnapLogic API Manager. The content is broken up into two sections and intended for the following audiences:

Architectural Best Practices

As an IT administrator, you have many options for deploying SnapLogic API Management. In this article, we summarize the network preparation required for the components that comprise the SnapLogic API gateway and provide an overview of each deployment architecture. This section applies to both using the API Policy Manager for Projects in Manager as well as API Policies applied to APIs in API Manager. Most API Management operations happen in the Control Plane and Snaplex nodes. Both types of Snaplexes – Self-managed (Groundplexes) and SnapLogic-managed (Cloudplexes) – are supported.

At least one JCC node is required for your APIM Snaplex. FeedMaster nodes are optional.

Network Preparation

Connectivity to the Snaplogic Control Plane

Your Snaplex makes outbound HTTPS requests to the SnapLogic Control Plane. A Self-managed Snaplex must be configured to communicate with the Control Plane over the HTTPS port 443. You also need to add SnapLogic component IP addresses to your network outbound allow list. Learn more about https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/2685698099/Groundplex+Network+Setup?src=search.

Info

Triggered Tasks have the option of calling an API with the Cloud URL on the Task Details page. This means the request is sent to the Control Plane before it is executed in the Data Plane. APIM does not support using this method to execute APIs. The request must by made with the Snaplex or Alternative URLs.

Network Setup around your self-managed Snaplexes

We recommend using a load balancer in front of your self-managed Snaplexes. Learn more about load balancer requirements for running Triggered and Ultra Tasks on self-managed Snaplexes.

For greater control over outbound communication with the SnapLogic Control Plane, you can also deploy Groundplex Access Control.

FeedMaster Node Configuration

If you plan to include Ultra Tasks in your APIs, you must have a FeedMaster node in that Snaplex. The SnapLogic-managed Snaplex includes FeedMaster nodes, but you have to configure the FeedMaster node for a Self-managed Snaplex. Learn more about deploying FeedMaster nodes and deployment architecture for Ultra Tasks.

Triggered and Ultra Tasks

Calling Triggered and Ultra Task URLs from outside the SnapLogic domain requires Access Control for Triggered and Ultra Tasks.

...

  • Use the Migrate an API Version Public API to migrate all your APIM assets in a version, including the policies from the source Org/Environment to the destination Org/Environment.
    OR

  • As an alternative, you can move the APIs to the destination Org/Environment with the Export and Import an API version Public APIs. This option will export the assets to a zip format you can download from the source Org/Environment to your local environment. You can then upload the API version and its assets as one zip file to the destination Org/Environment.

...

Naming Endpoints

  • Use nouns instead of verbs for URI endpoints.

  • Pluralize all resources.

  • Use a comma to punctuate lists.

  • Enable query parameters to sort or filter information.

  • No special characters

  • Use lowercase

  • No abridgments

  • Avoid jargon; use intuitive terms.

  • Do not add a trailing forward slash to your URI

  • Do not use file extensions