Skip to content

Java Code Examples ​

This guide demonstrates how to use the Spark API with Java. The example project shows you how to authenticate and fetch data from the API using standard Java libraries.

Requirements ​

  • Java 8 or higher
  • Maven (for dependency management and building)

Getting Started ​

1. Download the Sample Project ​

Get the complete sample project: Java API Sample

This project demonstrates how to:

  • Authenticate with the Spark API using OAuth2
  • Make authenticated requests to API endpoints
  • Parse and handle JSON responses

Dependencies used:

  • Apache HttpClient - For HTTP communication
  • Gson - For JSON parsing

2. Configure Your Credentials ​

Set your API credentials as environment variables:

shell
export SPARK_CLIENT_ID=your_client_id_here
export SPARK_CLIENT_SECRET=your_client_secret_here

Alternative Configuration

You can also modify the sample code to load credentials from a configuration file or other sources.

3. Run the Application ​

You have two options to run the sample:

Option A: Run from Your IDE ​

Open the project in your favorite Java IDE (IntelliJ IDEA, Eclipse, VS Code) and run the main method in SparkAPISampleApp.java

Option B: Run with Maven ​

shell
mvn compile exec:java -Dexec.mainClass="com.sparkcommodities.api.SparkAPISampleApp"

Building the Project ​

To build the project and download dependencies:

shell
mvn clean install

This will:

  • Download all required dependencies
  • Compile the source code
  • Run any tests (if present)
  • Package the application

Troubleshooting ​

Build errors?

  • Ensure Java 8 or higher is installed: java -version
  • Verify Maven is installed: mvn -version
  • Check that pom.xml is present in the project root

Authentication errors?

  • Verify your environment variables are set correctly
  • Ensure your credentials haven't expired
  • Check that your subscription has API access

Dependency issues?

  • Run mvn clean install to refresh dependencies
  • Check your internet connection (Maven needs to download dependencies)

Need help? Contact us at support@sparkcommodities.com