SDK Documentation
SDK Integration Overview
As a partner you can interact with 11Sight’s system using this External API. Functions that allow you to complete various tasks can be found in the API Reference section.
You need to have a partner account and a token in order to make requests to the External API. A token is a secret identifier that is unique for each partner and should be sent in the header when making requests.
Tokens are secret values that should not be shared with third parties, since whoever has the token can make changes to your subscribers and services that are offered to them.
Tokens are assigned to each partner by 11Sight administrators. To receive a token, please contact Sales. if you already have asked for a token, please contact Support.
Selecting the correct environment
We have two different environments you can use with the SDK: Production and Sandbox.
Sandbox environment can be reached using this URL. This is for testing and development purposes only and should only be used for testing.
Production environment can be reached using this URL and is for production purposes.
When you are making a development, you can use the Sandbox environment freely to create users, make calls etc. When your app is released, you need to connect to the Production environment. If you use Sandbox environment on your released apps, you can experience problems.
You need to setup Production and Sandbox environments separately.
Initial Setup
In order to start with the 11Sight API, you need to have a user account. To get a user account, please contact Support.
After logging to the site https://sdk.11sight.com/user/sign_in with your user name and password, you need to setup Apple and/or Google certificates in order to receive notifications and start integrating with the SDK. These certificates should be entered in the Partner Manager section.
You can see a list of your users and their basic call statistics. You can also see their buttons and call them, if needed.
Option | Description |
iOS Production Certificate | This is the Apple Push Notification certificate which you can get from the Apple Developer portal. Push certificate should be able to send voip type notificaiton as well please choose corret one from developer portal while creating. You need to provide the file with pem extension which you can export from Keychain app in Mac OS. Pem file should contain both the certificate and private key. |
iOS Bundle Id | This is your iOS app's bundle id. |
Android FCM Key | This is the FCM (or GCM) key that you should obtain from Google Console to send messages. |
Android App Key | This is the secret app key associated with your app. |
Android Bundle Id | This is your Android app's bundle id. |
If you will only use the iOS app, you don't need to fill in Android related options (or vice versa).
This information is required to send push notifications to your app when a call is initiated for the logged in user. When these options are not provided, logged in users on your app will not be able to receive calls when the app is in the background. But they can still receive calls when the app is open and in the foreground.
Once these options are set you, are ready for the SDK integration.
How to start with App SDK
After setting up your certificates and keys, you need to add our SDK to your app. SDK provides a complete package for you that handles everything related to call management. All you have to do is integrate the SDK inside your app, initialize it and add our push notification check code in notification handling.
In the next two sections, we will describe how to do the above for iOS and Android platforms.
iOS
General Info About SDK
SDK is not compatible with iOS Simulator because of SIP libraries.
SDK comes with persistent login feature, so you don't need to login every time app becomes active, you should call login once, then the SDK will handle rest of it. Same is true for logging users out.
SDK implementation expects a certain code implementation order to fulfill call structure. None of the SDK methods should be called twice in a row.
Android
Push Notification Handling
If your application uses Push Notifications, there is a method which can help you to differentiate whether received notification belongs to SDK or not.
public class MyFirebaseMessagingService extends FirebaseMessagingService {
@Override
public void onMessageReceived(final RemoteMessage remoteMessage) {
// isIISightNotification returns true if notification comes from 11Sight and false if it's comes
from another server
boolean check = SDKManager.getSdkManager().isIISightNotification(remoteMessage,
MyFirebaseMessagingService.this);
if (check) {
// Handle 11Sight notification SDKManager.getSdkManager().handleIISightNotification(remoteMessage);
}else{
// Handle message from other servers
}
}
}Important: handleIISightNotification() method handles incoming calls and has to be implemented.