Getting Started

This guide shows you how to set up a project. If you are coming from any of the samples, note that (most of) these steps have already been done ahead of time.

Platform Compatibility

We test our SDK against the following platforms:

  • iOS
  • Android

The minimum version supported for each platform depends on the version of NativeScript. We support NativeScript version 3.x and above.

Add an App Backend

If you don't have an account on Kinvey yet, please signup before continuing.

In the Kinvey console, create a new app backend. If you are currently viewing another app backend, click the app's name in the left navigation, and the select "New App" in the menu.

On the app dashboard page, you will find your App Key and App Secret in the top right. You’ll need those to configure your app.

Set Up a NativeScript app

Follow the NativeScript Getting Started Guide to set up a NativeScript app.

In case you are setting up a NativeScript & Angular app, you can start off with the NativeScript with Angular Master Detail Template and build on it.

For an overview of the types of features that the Kinvey NativeScript SDK enables, check out our video tutorial.

Add Kinvey SDK

You can add the Kinvey SDK to your project in one of two ways - using the package we ship, or using the source code.

Using Package

Install the Kinvey NativeScript SDK as a plugin for your NativeScript app.

tns plugin add kinvey-nativescript-sdk

Using Source Code

The Kinvey NativeScript SDK is open source. If you prefer to build your app against the SDK source code, you can follow the instructions on our github repo to set up the SDK.

Configure Your App

To use the SDK, you need to initialize it with your App Key and App Secret.

import { Kinvey } from 'kinvey-nativescript-sdk';
Kinvey.init({
    appKey: '<appKey>',
    appSecret: '<appSecret>'
});
var Kinvey = require('kinvey-nativescript-sdk').Kinvey;
Kinvey.init({
    appKey: '<appKey>',
    appSecret: '<appSecret>'
});

Kinvey.init() also accepts the following options when initializing the SDK:

OptionDescription
appVersionSet a version for your app that will be sent as the header X-Kinvey-Client-App-Version on every network request.
defaultTimeoutSet the default timeout used for all requests. The value must be in milliseconds. The default value is 60000 ms (1 minute).

Dedicated Kinvey customers, you'll need to set the API host name for the SDK to your dedicated Kinvey host name. You can find this host name on the dashboard of the console, next to your App Key and App Secret:

import { Kinvey } from 'kinvey-nativescript-sdk';
Kinvey.init({
    apiHostname: 'https://<my-subdomain>-baas.kinvey.com',
    micHostname: 'https://<my-subdomain>-auth.kinvey.com',
    appKey: '<appKey>',
    appSecret: '<appSecret>'
});
var Kinvey = require('kinvey-nativescript-sdk').Kinvey;
Kinvey.init({
    apiHostname: 'https://<my-subdomain>-baas.kinvey.com',
    micHostname: 'https://<my-subdomain>-auth.kinvey.com',
    appKey: '<appKey>',
    appSecret: '<appSecret>'
});

Examples for apiHostname and micHostname would be:

apiHostname: 'https://kvy-us2-baas.kinvey.com'
micHostname: 'https://kvy-us2-auth.kinvey.com'

Never use the Master Secret in client-side code.

Verify Set Up

Your app is now connected to Kinvey. The ping method, as shown below, will contact the backend and verify that the SDK can communicate with your app.

Kinvey.ping()
    .then((response) => {
        console.log(`Kinvey Ping Success. Kinvey Service is alive, version: ${response.version}, response: ${response.kinvey}`);
    })
    .catch((error) => {
        console.log(`Kinvey Ping Failed. Response: ${error.description}`);
    });
Kinvey.ping()
    .then(function(response) {
        console.log('Kinvey Ping Success. Kinvey Service is alive, version: ' + response.version + ', response: ' + response.kinvey);
    })
    .catch(function(error) {
        console.log('Kinvey Ping Failed. Response: ' + error.description);
    });

If the response just yields hello instead of hello app-name, please make sure you have configured your app. If the error yields This app backend not found, the app key and app secret you entered are incorrect.

Every App has an Active User

Your app will be used by a real-life human being. This person is represented by the Active User. This user object must explicitly be created, either with a username and password, OAuth sign-on (such as Facebook, Google+, LinkedIn, etc.), or Mobile Identity Connect. See the User Guide for more information.

What's next

You are now ready to start building your awesome apps! Next we recommend diving into the User Guide or Data Store Guide to learn more about our service, or explore the sample apps to go straight to working projects.

Related Samples

Got a question?