NAV Navbar
cURL Java JavaScript Ruby Python
  • EBSCO LinkIQ
  • EBSCO LinkIQ

    Overview

    Welcome to the LinkIQ reference documentation.

    The EBSCO LinkIQ service enables the configuration and management of full text linking based on open URL standards.

    Authentication

    Service Endpoints

    Sandbox Environment
    https://sandbox.ebsco.io    
    
    Production Environment
    https://api.ebsco.io
    

    You will need a valid customer profile in order to access the LinkIQ service. In order to authenticate to the LinkIQ service, you need to pass the customer profile as a path parameter with every request.

    Version information

    Version : 1.0.0

    Contact information

    Contact : the EBSCO API Team
    Contact Email : support@ebsco.com

    License information

    License : Copyright EBSCO

    URI scheme

    Sandbox Environment : sandbox.ebsco.io
    Production Environment : api.ebsco.io
    BasePath : /ftf/ftfaccount
    Schemes : HTTPS

    Tags

    Consumes

    Produces

    Resource

    Full Text Finder Resource

    Resolve full text links based on an open url.

    Example Request

    curl -X GET --header 'Accept: application/json' --header 'password: PASSWORD' 'https://sandbox.ebsco.io/ftf/ftfaccount/CUSTPROFILE/openurl?issn=1234'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("ftf")
        .addPathSegment("ftfaccount")
        .addPathSegment(CUSTPROFILE)
        .addPathSegment("openurl")
        .addQueryParameter("issn", "1234")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("password", PASSWORD)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/ftf/ftfaccount/";
    var pathsega = "/openurl";
    
    // Create the Request
    var urlstr = host + CUSTPROFILE + pathsega;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
       data: { 
        "issn": "1234"
      },
      "headers": {
        "accept": "application/json",
        "password": PASSWORD
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'ftf', 'ftfaccount', CUSTPROFILE, 'openurl')
    uri = URI(urlstr)
    
    query = URI.encode_www_form({
        # Request parameters
        'issn' => '1234'
    })
    if query.length > 0
      if uri.query && uri.query.length > 0
        uri.query += '&' + query
      else
        uri.query = query
      end
    end
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    request["password"] = DUMMYPASSWORD
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/ftf','/ftfaccount/', CUSTID, '/openurl'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Set the Query Parameters
    params = urllib.parse.urlencode({'issn': '1234'})
    
    # Create the Request Headers
    headers = {
        'accept': "application/json"
        }
    
    # Send Request  
    conn.request("GET", url + '?' + params, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{profile}/openurl

    Description

    This operation allows you to resolve full text links based on an open url.

    Please Note: Parameters provided below are a sampling of OpenURL 0.1 keys that can be used when trying this service. When calling this service from your application, you can use any valid OpenURL 0.1 or OpenURL 1.0 key-encoded-value (KEV).

    Parameters
    Type Name Description Schema Default
    Header password
    optional
    Profile Password (optional). If password is supplied, it must be a valid password assigned to the customer profile. If omitted, the request will only be honored if the customer profile allows guest access. string
    Path profile
    required
    A valid customer profile in the form of customerid.groupid.profileid. string
    Query atitle
    optional
    The title of the article to look up. string
    Query id
    optional
    The identifier for the content item in the form of doi:{doi} or pmid:{PubMedID}. string "doi:10.1093"
    Query issn
    optional
    The ISSN of the journal or journal article to look up. string "1234"
    Query issue
    optional
    The issue number of the issue that the requested article appears in. string
    Query jtitle
    optional
    The title of the journal to look up. string "Nature"
    Query startpage
    optional
    The page the requested article appears on. string
    Query volume
    optional
    The volume number of the issue that the requested article appears in. string
    Responses
    HTTP Code Description Schema
    200 OK. Full Text Finder Links FTFLinksResponse
    400 BAD_REQUEST No Content
    401 UNAUTHORIZED No Content
    403 Forbidden No Content
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Produces

    Definitions

    ContextObject

    Name Description Schema
    contextObjectId
    optional
    When multiple context objects are supported on the request, this is the identifier from the request, otherwise it is 1
    Example : "1"
    string
    contextObject
    optional
    The context object submitted
    Example : "doi=10.1038"
    string
    contextObjectFacts
    optional
    List of facts generated by the FTF Resolver < Fact > array
    targetLinks
    optional
    List of links and supporting information generated by the FTF Resolver < TargetLink > array

    Coverage

    Name Description Schema
    coverageDates
    optional
    List of Coverage Dates < CoverageDate > array
    coverageStatement
    optional
    Coverage Statement
    Example : "Issues on or after 6/1/1992"
    string
    embargoUnitType
    optional
    Unit of Embargo enum (DAY, WEEK, MONTHANDYEAR)
    embargoValue
    optional
    Embargo Value
    Example : 1
    integer(int32)

    CoverageDate

    Name Description Schema
    coverageBegin
    optional
    Coverage Start Date
    Example : "2003-01-01"
    string
    coverageEnd
    optional
    Coverage End Date
    Example : "2003-12-12"
    string

    FTFLinksResponse

    Get FTF Links Response

    Name Description Schema
    contextObjects
    optional
    Structure to support multiple context objects, even if there is only one < ContextObject > array
    statsInfo
    optional
    Stats and other about the link resolution StatsOther

    Fact

    Name Description Schema
    name
    optional
    Name of the fact
    Example : "year"
    string
    value
    optional
    Value of the fact
    Example : "2011"
    string

    Note

    Name Description Schema
    noteId
    optional
    Unique identifier for the note
    Example : 42655
    integer(int32)
    noteName
    optional
    Note name
    Example : "Sample Note"
    string
    noteText
    optional
    Note text to be displayed on the menu
    Example : "This is a note."
    string
    iconLibRef
    optional
    Location (sprite number) of icon to use; only populated when the customer has chosen a standard EBSCO icon for a note; the "icon" is what appears next to the note to add context
    Example : 0
    integer(int32)
    iconUrl
    optional
    If customer uses own icon for a note, this is its URL. Null if no icon or using standard icon
    Example : "http://hostname.com/icon.png"
    string
    iconText
    optional
    Text to show on mouse-over for the icon
    Example : "Sample Icon Alt Text"
    string
    hoverText
    optional
    Hover text to show on mouse-over for the note
    Example : "Sample Icon Hover Text"
    string
    linkUrl
    optional
    URL of the note link if any
    Example : "http://hostname.com"
    string

    PackageInfo

    Name Description Schema
    coverage
    optional
    Coverage Info Coverage
    packageId
    optional
    Package ID
    Example : 160
    integer(int32)
    packageName
    optional
    Package Name
    Example : "Academic Search Premier"
    string
    titleId
    optional
    Title ID
    Example : "edp18612"
    string

    StatsOther

    Name Description Schema
    processingStartTime
    optional
    Time/Date stamp for start of processing
    Example : "2018-09-06T18:04:34.715Z"
    string
    processingDurationMsec
    optional
    Overall processing time in milliseconds
    Example : 2394
    integer(int64)
    transactionId
    optional
    TransactionID (GUID) as assigned by API
    Example : "f46b2ac4-dc1e-4184-9a59-2686b67d7526"
    string
    sessionId
    optional
    SessionID (GUID) from the incoming request as a SessionID parameter, or auto-generated
    Example : "a031f9da-fda7-4e4a-ba52-799efd702db0"
    string

    Name Description Schema
    linkId
    optional
    Unique identifier for the target link
    Example : 299596
    integer(int32)
    linkName
    optional
    Name of the target link
    Example : "Sample label name"
    string
    linkText
    optional
    Text of link assigned to FTF link; text that is expected to show on the link menu
    Example : "Sample Link Text"
    string
    rank
    optional
    Target link rank
    Example : 0
    integer(int32)
    category
    optional
    Type of link as determined by the resolver enum (FullText, LibraryCatalog, DocumentDelivery, AbstractIndexDatabases, ILL, SearchEngines, Other, NoveListBIR, SmartLinks, SectionLabel)
    hoverText
    optional
    Hover text to show on mouse-over for the target link text
    Example : "Sample Hover Text"
    string
    iconLibRef
    optional
    Location (sprite number) of icon to use; only populated when the customer has chosen a standard EBSCO icon; the "icon" is what appears next to the link to add context
    Example : 0
    integer(int32)
    iconText
    optional
    Hover text to show on mouse-over for the target link text
    Example : "Sample Icon Alt Text"
    string
    iconUrl
    optional
    If customer uses own icon, this is its URL. Null if no icon or using standard icon
    Example : "http://hostname.com/icon.png"
    string
    directLinkBehavior
    optional
    Required behavior of target link enum (DirectLinkBehavior, NoFTFDirectLink)
    baseUrl
    optional
    URL of the target link (if no proxy)
    Example : "http://hostname.com"
    string
    queryString
    optional
    If present, the query string that must be added to the baseUrl
    Example : "?url_ver=Z39.88-2004"
    string
    proxyUrl
    optional
    If the FTF link has a proxy applied, this is the proxied version of the link or else this is empty
    Example : "http://hostname.com"
    string
    packageInfo
    optional
    For links that are associated with one or more collection items, this object provides details on the package of the holding PackageInfo
    notes
    optional
    Zero or more notes assigned to or inherited by the package-title that are set to show in FTF < Note > array