API Integration Checklist

👍

Integrating new software solutions through an API can sometimes be a challenging task – which is why we want to make the process as smooth and as efficient as possible.

Below, you will find a checklist for integrating with Findify's Search and Merchandising software via our API. By following this checklist, you can ensure that you have covered all the necessary components to seamlessly integrate with our products and take full advantage of their capabilities.

The checklist is organized into different sections, each representing a specific logic or solution that our API supports. These sections include:

1. Autocomplete: For providing search suggestions, product matches, trending searches, and trending products to enhance the search experience.
2. Search Results: For implementing filters, product listings, sorting options, banners, and more to display relevant search results effectively.
3. Zero Results: To handle cases when no search results are returned and how to display "Trending Products" as a fallback.
4. Content Search: For content-based searches with options to return blog posts and Instagram posts.
5. Smart Collections: To enable custom collections with filters, sorting, banners, promo cards, and more.
6. Recommendations: For implementing recommendation widgets and dynamic content based on specific criteria.
7. Analytics: For tracking important user events such as page views, purchases, clicks, and more to gain valuable insights into user behavior.

📘

It is essential to note that merchandising rules can be configured through both the API and the Findify dashboard. To avoid potential conflicts, the default behavior is that rules specified in an API request will override those set in the dashboard for the same query. However, there is an advanced option available to merge rules from both sources if needed.

By following this checklist, you will not only streamline the integration process but also provide your users with a seamless and enhanced experience through our Search and Merchandising software.

Should you encounter any challenges or have any questions during the integration process, our support team is here to assist you on [email protected].

API INTEGRATION CHECKLIST

Autocomplete

• Search Suggestions
• Product Matches
• Trending Searches
• Trending Products
• Content Search
• Page Redirects

Search Results

• Filters
• Breadcrumbs
• Products
• Sorting Options
• Page Redirects
• Banners
• Promo Cards
• Partial Match > “Corrected Q”
• Full Match “Q” & “Count”
• Offset: Load More/Previous Buttons or Pagination
• Best Practice: Anchoring - Navigating back should bring you to the same results
• Best Practice: Placeholders Spinner/Cumulative

Zero Results

• If no items returned in Search API, return Recommendations API for “Trending Products”

Content Search

• Results
• Offset/Limit (Pagination)
• “Q”

Smart Collections

• Filters
• Breadcrumbs
• Products
• Sorting Options
• Banners
• Promo Cards
• Offset: Load More/Previous Buttons or Pagination
• Best Practice: Anchoring - Navigating back should bring you to the same results
• Best Practice: Placeholders Spinner/Cumulative
• Pinning/Merch Rules: Override dashboard rules

Recommendations

• Widget/Slot based
• ID in payload for dynamic in widget (needs to be configured in dashboard)
• Generic End-Point (ID for calculated)
• Optional: Filter in Payload
• Optional: Pin Position by Item Group-ID
• Fallback: Only Slot Based

Analytics

• Most Important, When, Where & Parameters
• View Page
• Purchase
• Click Item
• Update Cart
• Click Suggestion
• Add to Cart
• Redirect