Bulk File Feed

Bulk File Feed Bulk File Feed (BFF) Compatible applies to partners who have signed an agreement permitting them to keep and access their own copy of FamilySearch Family Tree data of deceased persons.

The BFF API is used to facilitate efficient and accurate maintenance of the partner’s copy of FamilySearch Family Tree data. Using the BFF API helps track bulk downloads allowing the update and maintenance process to occur in multiple sessions.

The following items will be reviewed for your solution to obtain BFF Compatible status.

[ ] A legal document giving the partner permission from FamilySearch to obtain a copy of the FamilySearch Family Tree data and offer it to their users.

[ ] Completion of BFF API orientation Training.

[ ] Successful authentication using service account private key.

[ ] Industry standards applied for keeping private key secure.

[ ] Use the BFF API for an initial download.

[ ] Use the BFF API to syncrhonize with FamilySearch Family Tree data.

[ ] Proper usage of Logo and Branding for FamilySearch Family Tree data

[ ] Use the BFF API to update the data at least every 24 hours.

Bulk Record Broker

Bulk Record Broker (BRB) Compatible applies to partners who have signed an agreement permitting them to keep and access their own copy of FamilySearch historical records.

The BRB API is used to facilitate efficient and accurate maintenance of the company’s copy of FamilySearch historical records. Using the BRB API helps track bulk downloads allowing the update and maintenance process to occur in multiple sessions.

The following items will be reviewed for your solution to obtain BRB Compatible status.

[ ] A legal document giving the partner permission from FamilySearch to obtain access to specific designated record collections and offer it to their users.

[ ] Received orientation training on the use of the BRB API.

[ ] Successful authentication using service account private key.

[ ] Industry standards applied for keeping private key secure.

[ ] Use the BRB API for an initial download.

[ ] Use the BRB API to stay up to date with the Bulk Record Broker periodically after the original download is confirmed.

[ ] Proper usage of Logo and Branding for FamilySearch records when presented to users.

Multi-Language

The following items will be reviewed for your solution to become Multi-Language Compatible.

[ ] The application supports Unicode (such as UTF-8 and UTF-16)

[ ] A configurable setup for the user interface is provided

[ ] Complete messaging for multiple languages. The user interface, messaging, and help translations can be:

Created by developers or users.
Integrated and distributed by the application.
Easily installed by user.

Browser Plug-ins

The popular Internet browsers such as Chrome, Explorer, Firefox, and Safari, support plug-ins that are sometimes called extensions or add-ons. Common examples are plug-ins that add features such as search-engines, virus scanners, or the ability to utilize a new file type.

Plug-ins can also be used to customize web pages. Intelligent insertion of HTML and JavaScript code into specific website pages can be used by plug-ins to add different functionality or customize the rendition of those pages. This document explains how plug-ins can add features to the FamilySearch web application. These custom features may add new functionality and change the look of the FamilySearch web application.

Complimentary Plug-ins

Plug-ins that add value for FamilySearch.org customers and are friendly to FamilySearch are considered complimentary. The following are guidelines for creating and deploying plug-ins that are complimentary.

The installation and use of the plug-in should clearly communicate the product function and company name.
Isolate the launching and use of the third-party plug-in from FamilySearch navigation, buttons, and links. There should be no confusion about when the user is using FamilySearch features and when the user is using the third-party plug-in features.
If the plug-in temporarily captures, analyzes, and presents data from FamilySearch, the user must first be informed and agree to allow the plug-in to use FamilySearch data.
Temporarily stored FamilySearch data should be eliminated when the browser is closed.
The plug-in should be “read-only”.
If the plug-in redirects to a FamilySearch page by opening a browser window or tab, before redirection the plug-in should inform the user of what is going to happen and explain any responsibility the user has for the results obtained. For example, the plug-in should inform the user it will check for duplicates before acting on possible ordinance opportunities.
Obtain and properly use a FamilySearch Campaign ID (CID) when calling a FamilySearch page (See “Linking to FamilySearch Pages” from your plug-in. Only use the CID assigned by FamilySearch for you specific plug-in.

Compromising Plug-ins

Plug-ins that do not add value for FamilySearch.org customers and are unfriendly to FamilySearch are considered compromising. The following are items to avoid in implementing and deploying plug-ins.

The plug-in creates greater potential for security problems.
User privacy could be compromised.
FamilySearch data is usable by someone other than the authenticated user browsing FamilySearch.org.
The added third-party features appear to be FamilySearch features.
The plug-in is intentionally working around messaging and process requirements of the FamilySearch web application.
The plug-in performs “screen-pushing” enabling writing to FamilySearch.org.

Preliminary Compatible Checklist

FamilySearch will not certify or reference plug-ins that do not use the FamilySearch API. The following is a simple list for plug-ins to be considered as compatible.

[ ] FamilySearch finds that the plug-in is complimentary and not compromising.

[ ] The plug-in launches a separate application that reads or writes to the FamilySearch API.

[ ] The plug-in does not insert any HTML or JavaScript code into FamilySearch web pages.

[ ] The developer intends to work with FamilySearch to improve FamilySearch features for users.

Linking or Redirecting

Solution Providers can connect features of FamilySearch to their app by directing users to an appropriate FamilySearch web page. Helpful information can be found in the guide for Linking to FamilySearch Pages and the guide for the Source Create Page.

The following items are required in order for your app to obtain Redirecting Feature Certification.

[ ] Read or Write Compatible

[ ] Follow FamilySearch Trademark and Logo Guidelines

[ ] Appropriate message is dislayed to user before redirecting to the target page (required only for solutions that write to Family Tree)

[ ] Acknowledge that FamilySearch only supports linking to pages as outlined in the Linking to FamilySearch guide. All other linking methods may break at any time without notice.

Linking to FamilySearch Pages