Onboarding Process
This document describes the steps required to complete the FINDMINE onboarding process for retailers using the JavaScript module. For additional technical assistance please feel free to contact us at support@findmine.com.
1. Share Product Information with FINDMINE
FINDMINE first needs to access your product information. There are two methods FINDMINE recommends sharing your product information on an ongoing basis:
- Drop feed files to FINDMINE's SFTP server:
- Feed files are required to contain specific product information such as title, description, price, image URL, item URL, etc. For more information on creating a feed file to match FINDMINE requirements, please review the Product Feed Guide.
- Once a feed file has been created and approved, it must be dropped into the FINDMINE SFTP. FINDMINE's SFTP is sftp.findmine.com; your account representative will provide you with a unique username and password with instructions on how to drop the feed file into the SFTP.
- After the initial feed drop, a recurring feed drop must be setup. Please work with your account representative to determine the best frequency (once per day is typically recommended).
- Use your product API:
- If you have a product catalog API, send the integration details to your account representative. This method ensures that product information is always up to date, and more complex/customizable integrations are possible.
Note: More frequent access to the product feed provides better product data synchronization. The FINDMINE team can accommodate custom product feed integrations if needed.
2. FINDMINE Feed Ingestion
FINDMINE uses your product feed to ingest your products into our system. We recreate each product in your feed as a FINDMINE Item that contains all the same data attributes as the original. We ensure that every Item has the proper Image, URL, Title, Price, and all other relevant facets.
Once we have completed ingesting your feed and reviewed all the Items, we begin creating looks, or Sets, that will be displayed on your website.
3. Integrate the JavaScript Module
Please see the complete, step-by-step technical documentation at JavaScript Module Integration Guide.
Integrating the Findmine Module through a tag manager is possible, please contact your account representative for more details.
The primary function of the module is to communicate with the FINDMINE servers in order to render suggested look(s) onto the webpage. When the JavaScript module successfully communicates with the FINDMINE servers and obtains recommendations, the JavaScript module generates the required HTML within the specified HTML element on the webpage.
4. Test in Staging
Once FINDMINE has completed the Feed Ingestion and the FINDMINE JavaScript Module has been embedded on your webpages, testing in your staging environment can begin. Your development or staging domain name, as well as a sample of products you'd like to match to looks for testing, must be shared with your account representative.
FINDMINE recommended looks will begin appearing as soon as FINDMINE is "turned on" in your staging environment. This enables you to review the recommendations, ensure that the module is rendering in the correct location on the page, and additional styling customizations can be made.
5. Customize Look and Feel
If using the JavaScript module, the default FINDMINE styling will be applied. FINDMINE understands that clients prefer the module to match the aesthetics of their site and FINDMINE is happy to work with your team to create custom CSS to accommodate your needs.
Alternatively, clients are free to apply their own custom CSS styling in place of using FINDMINE. If wishing to use your own CSS, it must be in a single CSS file to be shared with your FINDMINE account representative. FINDMINE will host this file on our Content Delivery Network (CDN) and serve the file together with the JavaScript module.
In order to develop custom styling:
- When live suggestions with dummy products are rendering in your store's development environment, develop the styling directly using tools such as Chrome DevTools, FireBug, etc.
- Once the CSS file is complete, send it to your FINDMINE account representative for hosting
6. Completion
At this point all your technical work is done.
Make sure to follow up with your account representative in order to ensure that your merchandising team's training is scheduled and that the FINDMINE team has received any and all styling guides, such as lookbooks or runway photo shoots that you may have.
Timeline
Client Tasks | FINDMINE Tasks |
---|---|
Client creates Feed File | |
Client drops Feed file in FINDMINE's SFTP server | FINDMINE inspects Feed and makes recommendations |
Client sets up recurring Feed drop | FINDMINE begins ingesting products |
Client integrates JavaScript module on webpages | FINDMINE ingestion continues |
Client turns on FINDMINE in staging environment | FINDMINE creates custom CSS styling (if desired) |
Client gives the go-ahead for production | FINDMINE points to production domain |
Completion | Completion |