spark3dp / spark-android-SDK

Integrate Spark APIs into your Android apps with this SDK library.

#Spark Android SDK

This open-source SDK library enables you to easily integrate the Spark 3D printing API into your Android applications.
Spark APIs are web based RESTful APIs providing an open, free and complete toolkit of professional-grade resources for 3D printing and related manufacturing processes.

Spark APIs are current in beta: Request access.

##Getting Started

Download this repository and import it into your project.

The Spark Android SDK comes with a sample app, located in the library’s App folder.

To use the Spark Android SDK you must first add an app on the Spark Developer’s Portal and save the app key and app secret Spark generates. For more information see the tutorial.

##Setting Up the SDK

##1. Initialization

Call the init method passing the app key and app secret allocated by the developer portal:

Spark.init(this, [APPKEY], [APPSECRET],[ENV_TYPE]);

Enable debug mode to see logcat messages regarding your configuration and any error messages or notifications.

Spark.setDebugMode(true);

##2. Authentication

Spark API use OAUTH 2.0 authentication.
There are two types of authentication available:

• Guest Token - For read only permissions. Gives you access to public data on Spark.
• Access Token - For read\write access to a Spark member’s private data. Access Tokens log the user in from your app.

###2.1 Generate a Guest Token

       SparkAuthentication.getGuestToken(new ISparkResponse<AccessTokenResponse>() {
            @Override
            public void onSparkSuccess(AccessTokenResponse responseObject) {
                ((EditText) 
			
             // Success !
             // Call Spark API
            }

            @Override
            public void onSparkFailure(String errorMessage) {
	        // Failure
            // Check error message
            }
        });

###2.2 Get Access Token

       SparkAuthentication.getAuthorizationCode(getActivity(),new ISparkResponse<AccessTokenResponse>() {
            @Override
            public void onSparkSuccess(AccessTokenResponse responseObject) {
            // Success !
	        // Call Spark API
           }
            @Override
            public void onSparkFailure(String errorMessage) {
            // Failure
            // Check error message
            }
            });

##3. Spark API Call Example

###3.1 Get Asset by ID

SparkDrive.getAsset(new AssetRequest([ASSET_ID]), new ISparkResponse<AssetResponse>() {<br>

            @Override 
            public void onSparkSuccess(AssetResponse responseObject) { 
            }
            @Override<br>
            public void onSparkFailure(String errorMessage) { 
             } 
             }); 

##4. List of the Spark API Available in the SDK

###4.1 Authentication API

      SparkAuthentication.getGuestToken(...); 
      SparkAuthentication.getAuthorizationCode(..); 

The Authentication API authenticates users and apps and provides access to the Spark API. Autentication API documentation: https://spark.autodesk.com/developers/reference/api/authentication.

###4.2 Drive API

     SparkDrive.createAsset(...); 
     SparkDrive.createFile(...); 
     SparkDrive.getAsset(...); 
     SparkDrive.getMemberAssets(...); 
     SparkDrive.getCurrentMember(...); 
     SparkDrive.getAssets(...); 
     SparkDrive.getMember(...); 

The Drive API stores 3D models and their files, uploads files for printing, provides social network services such as “like” of members, “favorite” models and attaches comments to models. Drive API Documentation: https://spark.autodesk.com/developers/reference/api/drive.

###4.3 Printer API

       SparkPrint.createJob(...); 
       SparkPrint.jobStatus(...); 
       SparkPrint.commandSend(...); 
       SparkPrint.registerPrinter(...); 
       SparkPrint.unregisterPrinter(...);

Spark Print API heals and prepares 3D models for printing, registers 3D printers for use, sends commands and 3D print jobs to 3D printers and monitors printer progress. Print API Documentation: https://spark.autodesk.com/developers/reference/api/print.

##Feedback

Please report bugs or issues to Spark Support at https://spark.autodesk.com/developers/support/inbox or simply let us know what you think of the SDK.