Skip to content

Instantly share code, notes, and snippets.

@dovy
Last active December 24, 2015 15:19
Show Gist options
  • Save dovy/6818839 to your computer and use it in GitHub Desktop.
Save dovy/6818839 to your computer and use it in GitHub Desktop.

Integrate RecordSeek on your website!

RecordSeek is a service that allows users to link any page on the net to an ancestor's profile on FamilySearch. In order to make this an easy integration, the following document has been created. For production use please contact [email protected] for pricing and maintenance details.

Step 1 - Get a FamilySearch Developer Key

FamilySearch will allow you to utilize RecordSeek as a method to gain a developer key. We can be a proxy for you, but you need to go through the proper process. First, you will need to go here to request a key: https://familysearch.org/developers/docs/guides/getting-started

Then after you've been approved, you will need to get it promoted to production level. Once that occurrs, send an email to [[email protected]](mailto:[email protected]?subject=RecordSeek Integration). Tell me your key, secret, and site URL you will be sending links from.

Step 2 - Generate your own URL

There is nothing special about the RecordSeek bookmarklet. It simply is used to generate a custom URL. As a developer of a third-party product, you will more than likely want to generate your own URLs, citations, and descriptions. The following docs will enable you to generate a proper URL. I leave the styling, and popup implementation up to you. I would get approval from FamilySearch before you make it full production.

http://recordseek.com/share/ is the base.


Variables for URL

Below you will find a table of optional values for RecordSeek. You will need to define the get perameters in the URL.

tag Type Required Description
_ (underscore) Unix Timestamp X You must provide a Unix Timestamp when you generate the URL.
url string X This is the URL that will be generated for your source on FamilySearch. It must be a valid URL that anyone can access. A paid wall is fine as long as you display some details about the sourced page. Redirects or the same paid walls will result in yoru site being blocked by FamilySearch.
title string If not set, one will be generated via curl remotely. This appears as the main description of the source citation. Be susinct and to the point.
citation string If not set, one will be generated using MLA citation standard with the date. It is suggested you include a date in this string if you set it yourself.
notes string If not provided, will default to Tree Connect bookmarklet available at RecordSeek.com..

Suggested Popup size

  • 800 width
  • 620 height

And that's it

Tinker around with your URL settings to see how it works.

Support Us

If you feel included, you are welcome to donate some money to encourage us to add features or a new service, or if you like what you see.

Donate to RecordSeek

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment