| Introduction
Implementation Instructions
Required Fields
Optional Fields
RSXML Examples
RIS Examples
Introduction
Partner sites may obtain a direct export API that allows
users to conveniently save records to EndNote online. This direct
export implementation supports data formatted in either the RIS or RSXML format.
Implementation
Instructions
In order to use EndNote online Direct Export, you must add a direct export URL
link to your site that includes the specified required fields listed below and
optional fields as desired. This link will open EndNote online in the same or new
browser, depending on the link target value. The link also includes the location
on your server where you are storing the formatted reference data. EndNote online
validates the user if necessary, and imports the data from that URL.
In addition, if you plan to export records in RSXML format, you should validate the XML against the EndNote.dtd, which is available at http://www.endnote.com/support/helpdocs/endnote.zip
Required
Fields
- func=directExport
- dataRequestUrl=[ENCODED_URL_FOR_DATA_RETRIEVAL]
This is a fully qualified url that is encoded to be url safe. EndNote online
will use this url to do an HTTP GET to retrieve data to be imported into the
user's EndNote online Library. The default and recommended format is RSXML.
- partnerName=[Data Provider Name]
This is the name identifying your site as the data provider. Note that
special characters will need to be encoded.
Optional
Fields
- partnerEmail=[PartnerTechnicalContactEmail]
This optional field is strongly recommended so that Clarivate Analytics can
contact the data provider if problems arise. (e.g., techcontact&40dataprovider.com)
- dataIdentifier=1
dataidentifier 1 indicates that the reference data is stored in the RIS format.
The default value is 0 indicating the data is stored in RSXML format (v2.5).
For RSXML, data is validated against the DTD.
- partnerReturnUrl=[ENCODED_RETURNURL]
This is a fully qualifed URL that is encoded to be URL safe. If specified,
EndNote online will display the import results page and after a specifed time,
redirect the user's web browser to this url.
RSXML Examples
Initiating Direct Export in a New Window:
Below is a URL example to open EndNote online in a new browser window. A link
constructed with target="_blank" will open EndNote online in a new
browser window. If the user is already logged into EndNote online, they will
be brought to the EndNote online Import results page. If they have not logged
in, they will need to log in through the login page to complete the direct
export process.
<a href="http://www.myendnoteweb.com/?func=directExport&partnerName=DataProvideName
&dataRequestUrl=ENCODED_URL_FOR_DATA_RETRIEVAL" target="_blank">Export
to EndNote online</a>
Note: Breaks appear in the link above for presentation purposes only.
Link for RSXML data without return URL - Export
to EndNote online
Initiating Direct Export in the Same Window:
Below is a URL example to open EndNote online in the same browser window:
A link constructed without target="_blank" will open EndNote online
in the same browser window. Once the user is authenticated, the user will
be brought to the Import results page. If the partnerReturnUrl is specified,
after a specified time period, the user will be redirected back to the partnerReturnURL.
<a href="http://www.myendnoteweb.com/?func=directExport&partnerName=DataProviderName
&dataRequestUrl=ENCODED_URL_FOR_DATA_RETRIEVAL
&partnerReturnUrl=ENCODED_RETURNURL&">Export to EndNote online</a>
Note: Breaks appear in the link above for presentation purposes only.
Link for RSXML data with return URL - Export
to EndNote online
RIS Examples
Initiating Direct Export in a New Window:
Below is a URL example to open EndNote online in a new browser window. A link
constructed with target="_blank" will open EndNote online in a new
browser window. If the user is already logged into EndNote online, they will
be brought to the EndNote online Import results page. If they have not logged
in, they will need to log in through the login page to complete the direct
export process.
<a href="http://www.myendnoteweb.com/?func=directExport&partnerName=DataProvideName&dataIdentifier=1
&dataRequestUrl=ENCODED_URL_FOR_DATA_RETRIEVAL" target="_blank">Export
to EndNote online</a>
Note: Breaks appear in the link above for presentation purposes only.
Link for RIS data without return URL - Export
to EndNote online
Initiating Direct Export in the Same Window:
A link constructed without target="_blank" will open EndNote online
in the same browser window. Once the user is authenticated, the user will
be brought to the Import results page. If the partnerReturnUrl is specified,
after a specified time period, the user will be redirected back to the partnerReturnURL.
<a href="http://www.myendnoteweb.com/?func=directExport&partnerName=DataProviderName&dataIdentifier=1
&dataRequestUrl=ENCODED_URL_FOR_DATA_RETRIEVAL
&partnerReturnUrl=ENCODED_RETURNURL&">Export to EndNote online</a>
Note: Breaks appear in the link above for presentation purposes only. Link for RIS data with return URL - Export
to EndNote online
|