README.md

Analytics API Engines Java SDK

Use this library to integrate with FactSet's Analytics APIs. Below APIs are supported by this SDK.

• PA Engine API
• SPAR Engine API
• Vault API

Contents

• auto-generated-sdk - Auto-generated code using Analytics API Engines SDK Generator
• examples - Sample project containing code snippets to quickly get started with the SDK
• tests - Integration tests

Requirements

• Java 1.7 or Java 1.8
• Maven to build and install the SDK

Installation

• Install the SDK to your local Maven repository:

  mvn install -DskipTests

• Install the client dynamically by adding a dependency to the POM file:

  <dependency>
    <groupId>com.factset.analyticsapi</groupId>
    <artifactId>engines-sdk</artifactId>
    <version>ARTIFACT_VERSION</version>
  </dependency>

Usage

Refer examples project for sample code snippets to quickly get started with the SDK

Tests

First, clone the repo locally and cd into the directory.

git clone https://github.com/factset/analyticsapi-engines-java-sdk.git
cd tests

Before running the tests, set the below environment variables. Use the Developer Portal Manage API Keys page to get these values.

export ANALYTICS_API_USERNAME_SERIAL = "username-serial"
export ANALYTICS_API_PASSWORD = "apikey"

Run the tests with below command.

mvn -q test -Dtest=ApiTestsRunner

Contributing

• Files in auto-generated-sdk directory are auto-generated and should not be manually edited here. Refer Analytics API Engines SDK Generator for instructions on how to modify these files.
• Projects examples and tests are open to enhancements and bug fixes. Please create a pull requests with the proposed changes.