REST Snap Pack (Not Recommended)

Overview

You can use the REST Snaps to execute HTTP methods on a REST API service endpoint.

Note:

We highly recommend that you use the HTTP Client Snap instead of REST Snaps to take advantage of the Capabilities of HTTP Client Snap. Learn more about Migrate from REST Snaps to HTTP Client Snap.

Overview

When integrating APIs and services, you can use either the HTTP Client Snap or the REST Snaps. While both Snaps facilitate HTTP requests, the HTTP Client Snap offers multiple benefits:
Table 1. Benefits of using HTTP Client Snap
Feature Details
Greater flexibility and customization
  • Provides additional control over request construction and modification by supporting a wider range of authentication methods and header configurations.
  • Enables seamless integration with APIs requiring specific payload formats.
Learn more: Configuring API Suite Accounts
Enhanced performance and efficiency
  • Optimized for faster execution of HTTP requests by supporting efficient bulk processing capabilities.
  • Asynchronous support for improved throughput and reduced execution time.
Learn more: Example: Send records in a batch using a POST method
Extended protocol and payload support
  • Supports advanced HTTP methods (for example, PATCH and custom methods).
  • Better handling of raw HTTP responses and non-standard API interactions with improved support for non-JSON payloads (for example, XML and multipart form-data).
Learn more: Example: Update data in the endpoint using a PATCH method
Improved debugging and error handling
  • Provides detailed logging and troubleshooting options through advanced error-handling and granular retries and timeouts.
Learn more: HTTP Client#Troubleshooting
Pagination support due to its flexibility and configurability
  • Supports various pagination methods:
    • Page-based pagination (page or offset parameters in the URL)
    • Cursor-based pagination (next page token or cursor from API response)
    • Header-based pagination (pagination information provided in response headers)
  • Dynamic token extraction: The HTTP Client Snap enables you to dynamically extract the next page token from the API response (headers, body, or even a nested field) and use it in the subsequent request. The REST Snap Pack is more rigid in handling custom pagination mechanisms.
  • Full control over API calls: You can define the pagination limit, offset, cursor, or token placement directly within the HTTP Client Snap’s request settings. This is useful when working with APIs that require non-standard pagination handling.

Learn more:
Ideal for comprehensive use cases
  • Designed for complex integrations that require fine-grained control over HTTP requests.
  • Designed for scenarios where REST Snaps' predefined configurations are restrictive.
  • Useful for APIs with non-standard authentication or response structures.
Learn more: HTTP Client Examples
Note: Migrating from REST Snap to HTTP Client Snap
  • While migrating from REST Snaps (in the existing pipelines) to HTTP Client Snap is not necessary, we recommend it for the aforementioned reasons.
  • If you choose to migrate to incorporate the benefits of the HTTP Client Snap, SnapLogic provides migration tools that automatically convert pipelines with REST Snaps and accounts to equivalent pipelines with HTTP Client Snaps and accounts. Learn more about the migration tool.

Supported versions

This Snap Pack is tested against http components version 4.4.12.

Best Practices

Build your integrations faster by leveraging patterns in the SnapLogic community for the REST Snaps to connect applications such as Slack.

Frequently Asked Questions

Can I continue to use REST Snaps in my existing pipelines?

Yes, your existing pipelines containing the REST Snaps will continue to work. However, SnapLogic recommends that you use the HTTP Client Snap for new integrations.

How do I migrate existing REST Snap pipelines to the HTTP Client Snap?

SnapLogic offers automated migration tools to facilitate the migration of REST accounts and pipelines to the HTTP Client Snap. Learn more.

Will SnapLogic continue to provide enhancements to REST Snaps?

SnapLogic's primary connector for REST-based integrations is the HTTP Client Snap. Consequently, all future updates, new features, and enhancements will focus on the HTTP Client Snap.

Although SnapLogic will not add new features to the existing REST Snaps, we will continue to provide limited support for REST Snaps to ensure that existing production pipelines remain unaffected.