Java Software Development Kit

Download the SDK

Requirements

• JDK 17 and above
• Apache Maven 3.5+
• IEEE Xplore API Access Key

Source Setup

• Import the contents of the attached zip file as a maven project in your favorite java editor like eclipse or IntelliJ
• If you want to run the app from the command line then ensure Java and Maven are in your Path and run mvn: clean package
• The project has an application.properties file. The API URL, Customer ID and the API Access Key are configured in there.
• If you run into any issues with the JDK Path in eclipse, try this:
  • In Eclipse, open Window | Preferences | Java | Installed JREs, make sure there's a JDK (and not just a JRE) for Java 17, then go to the submenu Execution Environments and mark this JDK as compatible with JavaSE-17 or higher. After that, Maven | Update Project should work as desired.
  • See the pom.xml in the source for the dependencies. Please make sure you have the JDK version listed in pom (maven.compiler.source tag) as the same JDK (17+) in the editor.

Methods Overview

Note: Parameters are usually strings so they should have quotes around them.

Query Methods

Class: org.ieee.ieeexplore.service.IEEEService

Filter and Sort Methods

Results Method

Running the Query and Getting Results

Defaults

• Data type defaults to JSON.
• Position 1 in the set of results is the starting position.
• Results sort by Article Title and in ascending order (A-Z) by default; if the Content Type is set to ‘Standards’ then sorting is by Publication Year because Standards do not have some of the other sorting fields.
• Maximum number of results returned defaults to 25.

Examples

Italicized text in the examples below should be replaced with your desired values.

Find Auth Token

String token = IEEEService.retrieveAuthToken().getToken();
The following properties are expected to be in the application.properties file.

#Auth Token Endpoint
auth.token.endpoint=https://ieeexploreapi.ieee.org/api/v1/auth/token

#Auth Token
auth.token=

#API Key
api.key=


application.properties sample

-- the application.properties file should have the following properties specified.

# End Point Other than Open Access Articles and Full Text requests
api.endpoint=https://ieeexploreapi.ieee.org/api/v1/search/articles

# Used For: Open Access Articles lookup, Full Text requests, Citations requests
open.access.endpoint=https://ieeexploreapi.ieee.org/api/v1/search/document/

# Used For: paper cites and author bio
author.endpoint='https://ieeexploreapi.ieee.org/api/v1/author/';

#usage requests
usage.endpoint=https://ieeexploreapi.ieee.org/api/v1/user/

# Customer ID
customer.id=[replace with customerid]

usage.endpoint.service=/samlreport

#End Point used to request chargeable Full Text auth token
auth.token.endpoint=https://ieeexploreapi.ieee.org/api/v1/auth/token

#Auth Token
auth.token=[replace with auth token]

#API Key
api.key=[replace with api key]


#Token Expiration in minutes
auth.token.alive=15

Query Using Auth Token

	// @see callApi in IEEEService class.

	String params =
		new StringBuilder("?apikey=").append(API_KEY)
			.append("&includeTerms=true")
			.append("&startDate=").append(apiRequest.getStartDate())
			.append("&endDate=").append(apiRequest.getEndDate())
			.append("&cltoken=").append(token.getToken().trim())
			.toString();
	String url = USAGE_URL + params;
	HttpRequest request = HttpRequest.newBuilder()
		.version(HttpClient.Version.HTTP_2)
		.uri(URI.create(url))
		.GET()
		.build();
	HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
	String responseBody = response.body();

Query by Abstract Text

String response = IEEEService.findByAbstractText("query");

Query by Affiliation

String response = IEEEService.findByAffiliationText("query");

Query by Article Number

String response = IEEEService.findByArticleNumber("article_number");

Query by Article Title

String response = IEEEService.findByArticleTitle("query");

Query by Author Facet

String response = IEEEService.findByAuthorFacetText("query");

Query by Author Name

String response = IEEEService.findByAuthorName("query");

Boolean Query

Searches all configured metadata fields, abstract, and document text.

String response = IEEEService.findByBooleanText("boolean_query_without_parentheses");

Query by Open Content Type Facet

String response = IEEEService.findByContentTypeFacetText(“query");

Query by DOI (Digital Object Identifier)

String response = IEEEService.findByDigitalObjectIdentifier(“query");

Query by Open/Facet Value

String response = IEEEService.findByFacetText(“query");

Query by Index Terms

Queries text in Author Keywords, IEEE Terms, and Mesh Terms.

String response = IEEEService.findByIndexTerms(“query");

Query by ISBN

String response = IEEEService.findByIsbn(“query");

Query by ISSN

String response = IEEEService.findByIssn(“query");

Query by Issue Number

String response = IEEEService.findByIssueNumber(“query");

Query by Meta Data

Queries text in configured metadata fields and abstracts.

String response = IEEEService.findByMetaDataText(“query");

Query for Open Access Article

ApiRequest request = new ApiRequest();
request.setUsingOpenAccess(true);
request.setArticleNumber(“article number");
String response = IEEEService.callApi(request);

Query by Publication Facet

String response = IEEEService.findByPublicationFacetText(“query");

Query by Publisher Facet

String response = IEEEService.findByPublisherFacetText(“query");

Query by Publication Title

String response = IEEEService.findByPublicationTitle(“query");

Query by Publication Number

String response = IEEEService.findByPublicationNumber(“query");

Query by Publication Year

Note: Depending on publication the format of the year may vary.

String response = IEEEService.findByPublicationYear(“year");

Query by Meta Data, Abstract, or Document Text

String response = IEEEService.findByMetaDataText(“query");

Query by Thesaurus Terms

Note: Thesaurus Terms are also called IEEE Terms.

String response = IEEEService.findByThesaurusTerms(“query");

Query Involving a Wildcard

Note: include no more than two wildcard words. Each wildcard word must have a minimum of three characters preceding the wildcard (*).

String response = IEEEService.findByWildcard(“query*");

Query Involving Multiple Data Fields

ApiRequest request = new ApiRequest();
request.setAffiliationText(“query");
// add more search parameters
String response = IEEEService.callApi(request);

Query Involving Filtering and Sorting of Results

Note: Multiple filters can be added as long as a different data field is specified as its first parameter.

ApiRequest request = new ApiRequest();
Map<String, String> filterMap = new HashMap<>();
// add filtering criteria to filterMap
request.setResultsFilter(filterMap);
String response = IEEEService.callApi(request);

Query with XML Object as Data Output

ApiRequest request = new ApiRequest();
request.setDataType(“xml");
// add search parameters
String response = IEEEService.callApi(request);

Query with JSON Object as Data Output

Note: Data type defaults to JSON.

String response = IEEEService.findByAbstractText(“query");

Query with Citations

String response = IEEEService.citations(“articleNumber", “citationType");

Error Messages