Getting Started

Last updated last month

Get up and running with Pushlink in 6 small steps

1 Create an Account to obtain an API Key

Visit https://www.pushlink.com/signup.xhtml and create your free account.

You'll be redirected to the dashboard. Copy your API key from the navigation bar.

2 Import Pushlink in your Android Project

Option #1: Gradle

//project/build.gradle
allprojects {
repositories {
google()
jcenter()
maven { url "https://jitpack.io" }
}
}
//project/app/build.gradle
dependencies {
implementation 'com.pushlink:pushlink-android:5.5.3'
}

Option #2: Maven

<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>com.pushlink</groupId>
<artifactId>pushlink-android</artifactId>
<version>5.5.3</version>
</dependency>

Option #3: Download JAR File

Download pushlink-android-5.5.3.jar [s3 mirror]

3 Set up permissions in your AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
<application ... >
<provider
android:name="com.pushlink.android.FileProvider"
android:authorities="your.package.name"
android:exported="true" />
</application>

4 Call PushLink.start() in the Main UI Thread

public class PushLinkSetup extends android.app.Application {
@Override
public void onCreate() {
super.onCreate();
String yourDeviceID = Settings.Secure.getString(getContentResolver(), Settings.Secure.ANDROID_ID);
PushLink.start(this, R.mipmap.ic_launcher, "yourApiKey", yourDeviceID);
//you can use R.drawable.icon for older sdks
}
}

It's up to you to identify the device

Make sure you've read the Android Device ID Guide.

5 Build the APK and upload it to Pushlink

You can find the Upload Apk button in the main navigation at Pushlink dashboard.

If you are using Android Studio 3 you need to actually build the APK, not just run. Take a look at Android Studio 3 and FLAG_TEST_ONLY

6 Enroll your devices (Just install & run)

First installation options:

Option #1: From terminal

curl -o yourApp.apk 'https://www.pushlink.com/download?package=some.package.name&api_key=yourApiKey'
adb install yourApp.apk

You can also generate a hashed download link in the dashboard to hide your credentials.

Option #2: From the device itself

Download the APK from QRCode and install it.

Final words

That's it. Now, every time you upload a new apk version to Pushlink and makes that the current version, all the devices using your application will receive and apply the update.

Take a look at the whole docs to get an idea on what Pushlink can help you with.