We encourage our content partners and other projects to provide links both to our home page and deep links to specific EOL pages. Below are examples of increasing complexity that will help you connect your site better to the Encyclopedia of Life.
Intermediate: Generate an EOL search string to put on each of your taxon pages using the following formula: http://www.eol.org/search?q=corvus+brachyrhynchos
We recommend the canonical form of the name (without the authority and year information). These searches may give multiple results. If you want to ensure a single result, use one of the advanced methods.
Advanced: There are several options, depending on your resources and needs.
- Do manual searches or run NameLink to find the EOL IDs of the pages you want to link to. Then hard code the links in your pages. Recommended only for those with a small number of pages to link to.
Use the search method from the EOL API. The top result that is returned should be the one we think is the best match. You can then use the top result's EOL ID in the URL to address a specific page, e.g.: http://eol.org/api/search/Corvus%20brachyrhynchos?exact=1
This currently returns a single result with a <link> element containing the URL. It also provides the EOL ID, 1177464, in the <id>
element if that is more convenient for your application.
Use the search_by_provider method from the EOL API to translate identifiers from other specific providers that you know to EOL IDs. For example, if you have an ITIS TSN number, you can find out that the EOL provider hierarchy ID for ITIS is 529 using: http://eol.org/api/provider_hierarchies/1.0
This can then be used to translate the TSN for Corvus brachyrhynchos, 6849925, to the EOL id using: http://eol.org/api/search_by_provider/1.0/6849925?hierarchy_id=529 which again returns 1177464.