sf-extension-amce

AMCE Extension from Smartface

An extension to Oracle AMCE Connection with Smartface Native Framework.

Installation

AMCE Extension can be installed via npm easily from our public npm repository. The installation is pretty easy via Smartface Cloud IDE.

• Open terminal
• (cd ~/workspace/scripts && npm i -S sf-extension-amce)
• Finally require the extension as: require("sf-extension-amce")

How to use

• Init your AMCE config

const AMCE = require('sf-extension-amce');
var options = {
	'backendId': 'YOUR BACKEND ID', // Required
	'baseUrl': 'YOUR BASE URL', // Required
	'androidApplicationKey': 'YOUR ANDROID APP KEY', // Required only for analytics & events
	'iOSApplicationKey': 'YOUR IOS APP KEY', // Required only for analytics & events
	'anonymousKey': 'YOUR BASIC AUTHENTICATION ANONYMOUS KEY', // Required only to perform operations without logging in first
	'oAuthTokenEndpoint': 'YOUR OAUTH TOKEN ENDPOINT', // Required only if OAuth to be used
	'clientId': 'YOUR CLIENT ID', // Required only if OAuth to be used
	'clientSecret': 'YOUR CLIENT SECRET' // Required only if OAuth to be used
};
var amce = new AMCE(options);

• Login to AMCE (Example)

amce.login({
		'username': 'YOUR USER NAME',
		'password': 'YOUR PASSWORD'
	})
	.then(e => {
		alert("login succeeded");
	})
	.catch(e => {
		alert("login failed");
	});

• Send Basic Analytic Event (Example)

var options = {
	'deviceID': '112233', // Required
	'sessionID': '112233', // Required
	'eventName': 'sendBasicEvent'
};
amce.sendBasicEvent(options)
    .then(e => {
		alert("sendBasicEvent succeeded");
    })
    .catch(e => {
		alert("sendBasicEvent failed");
    });

API Documentation

Full api documentation is in api.md

Need Help?

Please submit an issue on GitHub and provide information about your problem.

Support & Documentation & Useful Links

• Guides
• API Docs
• Smartface Cloud Dashboard

Code of Conduct

We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the MIT license. See the LICENSE file. Within the scope of this license, all modifications to the source code, regardless of the fact that it is used commercially or not, shall be committed as a contribution back to this repository.