API to push custom content to Findify

Introduction

The Content API allows a client to push and then search content-based documents (articles, pictures, videos, etc).

A document can be:

  • a category page
  • an article from a blog
  • the content of a web page (e.g. FAQ, Sizing Charts, etc)
  • an Instagram post
  • a Youtube video
  • any content that has been generated by the user (UGC = User Generated Content)

Content API

The content search feature is composed of two main components:

  • The content API that allows a client to add, modify, or delete documents. This API is available under the domain push.findify.io.
  • The content search API that lets the client search into their content index. This API has a different endpoint and is available under the domain api-v3.findify.io.

When an operation has been submitted to the content API (addition/modification/deletion), it will take maximum five minutes for the system to propagate the operation in the Findify search engine.

🚧

Batch Operations Considerations

At the moment, we cannot guarantee that we will preserve the order of the operations exactly as we received them.

API Authentication

In order to push documents to the Content API, you need to request a private API key.

At the moment, the only way to get a private API key is to contact the Findify support, as Content Search is not yet available to all merchants.

When you have your private API key, you simply need to provide a header Authorization with the value Bearer PRIVATE_ACCESS_KEY.

You will obtain the Private Access Key and the source to be used in the API in the Merchant Dashboard when creating the Custom Content Source integration.

Contact yourfriend[email protected] for more information.

API Limits

You can pass maximum 6MB of payload per each request.

API Error Codes

HTTP Error Code

Description

400

Payload is not valid

401

Your Private Access Key is not valid

404

Content source provided is not found

405

Content source is not a Custom content source

500

Internal server error