CloudRail SI for Android
Integrate Multiple Services With Just One API
CloudRail is an API integration solution which abstracts multiple APIs from different providers into a single and universal interface.
Current Interfaces:
Full documentation can be found at our wiki.
Learn more about CloudRail on https://cloudrail.com
With CloudRail, you can easily integrate external APIs into your application. CloudRail is an abstracted interface that takes several services and then gives a developer-friendly API that uses common functions between all providers. This means that, for example, upload() works in exactly the same way for Dropbox as it does for Google Drive, OneDrive, and other Cloud Storage Services, and getEmail() works similarly the same way across all social networks.
Current Interfaces
| Interface | Included Services |
|---|---|
| Cloud Storage | Dropbox, Google Drive, OneDrive, Box, Egnyte |
| Business Cloud Storage | AmazonS3, Microsoft Azure, Rackspace, Backblaze |
| Social Profiles | Facebook, GitHub, Google+, LinkedIn, Slack, Twitter, Windows Live, Yahoo, Instagram |
| Social Interaction | Facebook, Twitter |
| Payment | PayPal, Stripe |
| Maljet, Sendgrid | |
| SMS | Twilio, Nexmo |
| Point of Interest | Google Places, Foursquare, Yelp |
Cloud Storage Interface:
- Dropbox
- Box
- Google Drive
- Microsoft OneDrive
- Egnyte
Features:
- Download files from Cloud Storage.
- Upload files to Cloud Storage.
- Get Meta Data of files, folders and perform all standard operations (copy, move, etc) with them.
- Retrieve user and quota information.
- Generate share links for files and folders.
Code Example:
CloudRail.setAppKey("[CloudRail License Key]");
// CloudStorage cs = new Box(context, "[clientIdentifier]", "[clientSecret]");
// CloudStorage cs = new OneDrive(context, "[clientIdentifier]", "[clientSecret]");
// CloudStorage cs = new GoogleDrive(context, "[clientIdentifier]", "[clientSecret]");
CloudStorage cs = new Dropbox(context, "[clientIdentifier]", "[clientSecret]");
new Thread() {
@Override
public void run() {
cs.createFolder("/TestFolder"); // <---
InputStream stream = null;
try {
AssetManager assetManager = getAssets();
stream = assetManager.open("UserData.csv");
long size = assetManager.openFd("UserData.csv").getLength();
cs.upload("/TestFolder/Data.csv", stream, size, false); // <---
} catch (Exception e) {
// TODO: handle error
} finally {
// TODO: close stream
}
}
}.start();Business Cloud Storage Interface:
- Amazon S3
- Microsoft Azure
- Rackspace
- Backblaze
Features:
- Create, delete and list buckets
- Upload files
- Download files
- List files in a bucket and delete files
- Get file metadata (last modified, size, etc.)
Code Sample
CloudRail.setAppKey("[CloudRail License Key]");
// BusinessCloudStorage cs = new MicrosoftAzure(context, "[accountName]", "[accessKey]");
// BusinessCloudStorage cs = new Rackspace(context, "[username]", "[apiKey]", "[region]");
// BusinessCloudStorage cs = new Backblaze(context, "[accountId]", "[appKey]");
BusinessCloudStorage cs = new AmazonS3(context, "[accessKeyId]", "[secretAccessKey]", "[region]");
new Thread() {
@Override
public void run() {
Bucket bucket cs.createBucket("testbucket");
// Loads a file from the application's assets and uploads it
AssetManager assetManager = getAssets();
InputStream stream = assetManager.open("UserData.csv");
long size = assetManager.openFd("UserData.csv").getLength();
storage.uploadFile(bucket, "Data.csv", stream, size);
Log.i("info", "Upload successfully finished");
}
}.start();Social Media Profiles Interface:
- Github
- Google Plus
- Slack
- Windows Live
- Yahoo
Features
- Get profile information, including full names, emails, genders, date of birth, and locales.
- Retrieve profile pictures.
- Login using the Social Network.
Code Example:
CloudRail.setAppKey("[CloudRail License Key]");
// final Profile profile = new GooglePlus(this, "[clientIdentifier]", "[clientSecret]");
// final Profile profile = new GitHub(this, "[clientIdentifier]", "[clientSecret]");
// final Profile profile = new Slack(this, "[clientIdentifier]", "[clientSecret]");
// final Profile profile = new Instagram(this, "[clientIdentifier]", "[clientSecret]");
// ...
final Profile profile = new Facebook(this, "[clientIdentifier]", "[clientSecret]");
new Thread() {
@Override
public void run() {
String fullName = profile.getFullName();
String email = profile.getEmail();
// ...
}
}.start();Social Media Interaction Interface:
Features
- Get a list of connections.
- Make a post for the user.
Code Example:
CloudRail.setAppKey("[CloudRail License Key]");
// final Social social = new Twitter(this, "[clientID]", "[clientSecret]");
final Social social = new Facebook(this, "[clientID]", "[clientSecret]");
new Thread() {
@Override
public void run() {
social.postUpdate("Hey there! I'm using CloudRail.");
List<String> connections = social.getConnections();
// ...
}
}.start();Payment Interface:
- PayPal
- Stripe
Features
- Perform charges
- Refund previously made charges
- Manage subscriptions
Code Example
CloudRail.setAppKey("[CloudRail License Key]");
// final Payment payment = new Stripe(this, "[secretKey]");
final Payment payment = new PayPal(this, true, "[clientIdentifier]", "[clientSecret]");
new Thread() {
@Override
public void run() {
CreditCard source = new CreditCard(null, 6L, 2021L, "xxxxxxxxxxxxxxxx", "visa", "<FirstName>", "<LastName>", null);
Charge charge = payment.createCharge(500L, "USD", source);
Log.i("info", "Charge: " + charge.toString());
}
}.start();Email Interface:
- Mailjet
- Sendgrid
Features
- Send Email
Code Example
CloudRail.setAppKey("[CloudRail License Key]");
// final Email email = new Mailjet(this, "[clientID]", "[clientSecret]");
final Email email = new Sendgrid(this, "[username]", "[password]");
new Thread() {
@Override
public void run() {
email.sendEmail("info@cloudrail.com", "CloudRail", Arrays.asList("foo@bar.com", "bar@foo.com"), "Welcome", "Hello from CloudRail", null, null, null);
}
}.start();SMS Interface:
- Twilio
- Nexmo
Features
- Send SMS
Code Example
CloudRail.setAppKey("[CloudRail License Key]");
// final SMS sms = new Nexmo(this, "[clientIdentifier]", "[clientSecret]");
final SMS sms = new Twilio(this, "[clientIdentifier]", "[clientSecret]");
new Thread() {
@Override
public void run() {
sms.sendSMS("CloudRail", "+4912345678", "Hello from CloudRail");
}
}.start();Points of Interest Interface:
- Google Places
- Foursquare
- Yelp
Features
- Get a list of POIs nearby
- Filter by categories or search term
Code Example
CloudRail.setAppKey("[CloudRail License Key]");
// final PointsOfInteres poi = new Foursquare(this, "[clientID]", "[clientSecret]");
// final PointsOfInteres poi = new Yelp(this, "[consumerKey]", "[consumerSecret]", "[token]", "[tokenSecret]");
final PointsOfInteres poi = new GooglePlaces(this, "[apiKey]");
new Thread() {
@Override
public void run() {
List<POI> res = poi.getNearbyPOIs(49.4557091, 8.5279138, 1000L, "restaurant", null);
Log.i("info", "POIs: " + res.toString());
}
}.start();More interfaces are coming soon.
Advantages of Using CloudRail
Consistent Interfaces: As functions work the same across all services, you can perform tasks between services simply.
Easy Authentication: CloudRail includes easy ways to authenticate, to remove one of the biggest hassles of coding for external APIs.
Switch services instantly: One line of code is needed to set up the service you are using. Changing which service is as simple as changing the name to the one you wish to use.
Simple Documentation: There is no searching around Stack Overflow for the answer. The CloudRail documentation at https://documentation.cloudrail.com/android/android/Home is regularly updated, clean, and simple to use.
No Maintenance Times: The CloudRail Libraries are updated when a provider changes their API.
Direct Data: Everything happens directly in the Library. No data ever passes a CloudRail server.
Maven
build.gradle
dependencies {
compile 'com.cloudrail:cloudrail-si-android:2.9.0‘
}
Sample Applications
If you don't know how to start or just want to have a look at how to use our SDK in a real use case, we created a few sample application which you can try out:
- Sample using the CloudStorage interface: File Viewer
- Sample using the Points of Interest interface: POI Finder
- Sample for the "Login with..." flow: Login With Sample
- Sample for using advanced authentication: Advanced Authentication
License Key
CloudRail provides a developer portal which offers usage insights for the SDKs and allows you to generate license keys.
It's free to sign up and generate a key.
Head over to https://developers.cloudrail.com
Pricing
CloudRail is free to use as long as your app is free as well. Learn more about our pricing on https://cloudrail.com/cloudrail-pricing/
Other Platforms
CloudRail is also available for other platforms like iOS, Java and NodeJS. You can find all libraries on https://cloudrail.com
Questions?
Get in touch at any time by emailing us: support@cloudrail.com
or
Tag a question with cloudrail on StackOverflow
