README.md

Java - Domo API SDK

About

• The Domo API SDK is the simplest way to automate your Domo instance
• The SDK streamlines the API programming experience, allowing you to significantly reduce your written code
• This package is published to maven central and bintray jcenter

Features:

• DataSet and Personalized Data Policy (PDP) Management
  • Use DataSets for fairly static data sources that only require occasional updates via data replacement
  • Add Personalized Data Policies (PDPs) to DataSets (hide sensitive data from groups of users)
  • Docs: https://developer.domo.com/docs/domo-apis/data
• Stream Management
  • A Domo Stream is a specialized upload pipeline pointing to a single Domo DataSet
  • Use Streams for massive, constantly changing, or rapidly growing data sources
  • Streams support accelerated uploading via parallel data uploads
  • Docs: https://developer.domo.com/docs/domo-apis/stream-apis
• User Management
  • Create, update, and remove users
  • Major use case: LDAP/Active Directory synchronization
  • Docs: https://developer.domo.com/docs/domo-apis/users
• Group Management
  • Create, update, and remove groups of users
  • Docs: https://developer.domo.com/docs/domo-apis/group-apis

Setup

The SDK can be added to your project in three ways:

It is currently hosted via bintray and JCenter (It will be in Maven central eventually):

repositories {
    maven {
        url  "http://dl.bintray.com/domoinc/domo-java-sdk" 
    }
}

Maven:

<dependency>
  <groupId>com.domo</groupId>
  <artifactId>domo-java-sdk-all</artifactId>
  <version>0.2.0</version>
</dependency>

Gradle:

compile 'com.domo:domo-java-sdk-all:0.2.0'

Classic Jar Import:

• Clone this repository
• Using a Bash Terminal, navigate to the cloned repository folder
• Create the Jar files via the Bash command ./gradlew publishToMavenLocal
• The Jars will be located in domo-java-sdk-all/build/libs/
• Copy the Jars to your project folder, and add them to your build path

Usage

• See the Client Test File for full usage and examples.
• Create an API Client on the Domo Developer Portal
• Use your API Client id/secret to instantiate a DomoClient()
• Multiple API Clients can be used by instantiating multiple Domo Clients
• Authentication with the Domo API is handled automatically by the SDK
• If you encounter a 'Not Allowed' error, this is a permissions issue. Please speak with your Domo Administrator.

public class Example {
    
    public void domoSDKUsage() {
        
        //Build an SDK configuration
        Config config = Config.with()
                .clientId("MY_CLIENT_ID")
                .clientSecret("MY_CLIENT_SECRET")
                .apiHost("api.domo.com")
                .useHttps(true)
                .scope(USER, DATA)
                .httpLoggingLevel(HttpLoggingInterceptor.Level.BODY)
                .build();

        //Create an instance of the SDK Client
        DomoClient domo = DomoClient.create(config);
        
        //Manage DataSets
        DataSetClient datasets = domo.dataSetClient();
        datasets.create();
        
        //Manage Streams
        StreamClient streams = domo.streamClient();
        streams.create();
        
        //Manage Users
        UserClient users = domo.userClient();
        users.create();
        
        //Manage User Groups
        GroupClient groups = domo.groupClient();
        groups.create();
    }
}

Snapshots

You can use snapshot versions through JitPack:

• Go to JitPack project page
• Select Commits section and click Get it on commit you want to use (top one - the most recent)
• Follow displayed instruction: add repository and change dependency (NOTE: due to JitPack convention artifact group will be different)