Provides an example of an application that calls the CHPL REST Services
Java 1.8.0 mvn 3.3.3
Using Git Bash, run the following command:
$ git clone https://github.com/chpladmin/sample-application.gitFirst, please obtain a valid API Key by registering on the CHPL Resources page at https://chpl.healthit.gov/#/resources
The CHPL REST API documentation may also be reached at https://chpl.healthit.gov/#/resources/chpl_api which provides information on possible API calls, HTTP Method, parameters, etc.
Let's walk through the different parts of a sample HTTP GET REST call, which can be performed programmatically or with an application such as Postman. For example: https://chpl.healthit.gov/rest/search?searchTerm= In order to successfully make the above REST call, the following must be defined:
HTTP method = GET
Headers:
- API-key: 12345a987654abc1abc1234a12ab1234
- Content-Type: application/json
When calling the API programmatically, it is best practice to define sensitive information, including the API Key, username and password, via a local properties file. Within this sample application, there is an environment.properties.template file. Rename this file to environment.properties, and update the property values as appropriate.
In this sample application, although example #4 uses authentication with the token obtained in example #1, please note that authentication is not a requirement for many API calls.
Also note that in this sample application, the API Key is truncated to 8 characters for display purposes.
Once your environment.properties file has been configured, open Git Bash (or terminal application of your choice), navigate to the SampleApp directory where the pom.xml file is located and execute the following command: mvn package This will create two jars in the /target directory:
- sampleApp-1.0-SNAPSHOT.jar
- sampleApp-1.0-SNAPSHOT-jar-with-dependencies.jar Navigate to the /target directory and execute the following command to run the application: java -jar sampleApp-1.0-SNAPSHOT-jar-with-dependencies.jar