...

Learn more about best practices and deployment architectures for APIM.

APIM Architecture

The following diagram illustrates the components of API Management Architecture.

...

Concepts

• API/API Version - A service that enables you to create an API with endpoints generated in SnapLogic (Triggered and Ultra Tasks) that supports versioning.

• Proxy - A service that enables you to make use of endpoints created outside of SnapLogic.

• Policy - A set of rules that enables you to apply criteria to APIs before execution, such as authorization, authentication, traffic shaping, and request/response transformation.

• Server - In APIM, a Snaplex is the server.

• Developer Portal - An external-facing page that hosts the API catalog for your Environment/Org.

...

• APIs

• API Versions

• Proxies/Endpoints

• Tasks (Triggered and Ultra)

• Pipelines

• Files (typically, specifications)

• Accounts

• Snap Packs (must be in global shared folder)

Requirements for Ultra Pipelines for Cloudplexes

• SnapLogic provisions FeedMaster and load balancer for Cloudplexes on request of a FeedMaster at no additional cost.

• We recommended you to have 2 FeedMasters and 2 JCC nodes in your Snaplex. However, if high availability is not a requirement, then 1 FeedMaster and 1 JCC node combination is recommended. With 1 FeedMaster and 1 JCC node combination, you can make successful task calls using the FeedMaster and Load balancer URL.

Prerequisite

• Subscription to APIM in Org

• Set up Groundplexes and FeedMasters

• configure load balancer

• Subscribe to policies Snap Pack

• Set up feature flags for APIM policies.Configure policies and share by import/export.

Step 1: Set up Developer Portal

...

To access APIs from an external application, the user needs to have an account (SnapLogic) or create one directly from the Developer Portal. If they follow the self-service registration process from the portal to create an account, it's similar to the IIP account setup for the process. However, an API administrator needs to approve the user-created portal account (this is done from API Management -> the Subscription Manager).

Create a login account to access the API Catalog in the Developer Portal.

...

• APIM does not support the Cloud URL for Triggered Tasks.

• The API Gateway should have dedicated infrastructure resources.

• If you alter the IP Address in the header, you need to do so with caution because it might cause adverse effects in case someone tries to spoof the header value and gain entry to a company’s system.

Additional Resources

The Design-First Workflow

...

You can create a new API in the /apim space of the API Manager and import or reference an API specification that defines the API. The new API comprises a Pipeline that is the scaffolding for the API and the Task used to call it. You can then create versions, add API policies, and modify the underlying SnapLogic assets to build the business logic for your API.

The following video demonstrates the workflow:

...

Learn more: Creating the API using Design First

The Pipeline-First Workflow

...

You can also create an API in the API Manager by referencing existing Projects in Manager. This allows you to design, build, and test your Pipeline first, thereby taking advantage of your existing SnapLogic infrastructure. As you build Pipelines and create Triggered Tasks from them, you vet them for production individually and concurrently. When your Pipeline and Tasks are production-ready, you can create APIs in the API Manager. 

The following video demonstrates the workflow:

...

Learn more: Creating the API from Existing Project Assets