NAS System Architecture Kill Switch Dev Guide 1

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 10

KILLSWITCH APPLICATION SERVICES
Developer Guide for Companion Devices
Document Version 01
Draft Notice
The information in this draft is KillSwitch Confidential and is the property of KillSwitch
International, Inc.
Confidential material must not be disclosed to any party without prior written consent from
KillSwitch International, Inc.
The information in this draft is not a commitment by KillSwitch International, Inc. to particular
features or capabilities of the product or to the publication or content of its documentation.
KillSwitch retains the right to postpone, revise, or cancel any proposed product and
documentation at any time prior to the release of the product or the publishing of the
documentation.
KillSwitch International, Inc.
KillSwitch
2 Confidential Property of KillSwitch International, Inc. KillSwitch Dev Guide
Notices
While KillSwitch believes the information included in this publication is correct as of the publication date, information in this
document is subject to change without notice.
UNLESS EXPRESSLY SET FORTH IN A WRITTEN AGREEMENT SIGNED BY AN AUTHORIZED REPRESENTATIVE OF
KILLSWITCH INTERNATIONAL, INC., KILLSWITCH AND ITS LICENSORS MAKE NO WARRANTY OR REPRESENTATION OF
ANY KIND WITH RESPECT TO THE INFORMATION CONTAINED HEREIN, INCLUDING WARRANTY OF MERCHANTABILITY
AND FITNESS FOR A PURPOSE. KillSwitch International, Inc. and its licensors assume no responsibility or obligation of any kind
for any errors contained herein or in connection with the furnishing, performance, or use of this document.
Software described in KillSwitch documents (a) is the property of KillSwitch International, Inc. or KillSwitch third party licensors, (b)
is furnished only under license, and (c) may be copied or used only as expressly permitted under the terms of the license.
All contents of this manual are copyrighted by KillSwitch International Inc. or KillSwitch third-party licensers. The information
contained herein is the exclusive property of KillSwitch International Inc. and shall not be copied, transferred, photocopied,
translated on paper, film, electronic media, or computer-readable form, or otherwise reproduced in any way, without the express
written permission of KillSwitch International Inc.
Guestserve, MediaCluster, Media Express, Multiverse, RAID2, KillSwitch, the KillSwitch logo, KillSwitch Axiom, KillSwitch
Quicksilver, SpotCast, VODlink, and VODcast are registered trademarks of KillSwitch International, Inc.
AdPulse and EXtreme are trademarks of KillSwitch International, Inc.
DVD Now, Game Now, and Voodle are service marks of KillSwitch International, Inc.
Intellispot is a registered trademark of Visible World, Inc.
Atlas is a registered trademark of Atlas, an operating unit of aQuantive, Inc.
Microsoft, MS, MS-DOS, Windows, Windows NT, and SQL Server are either trademarks or registered trademarks of Microsoft
Corporation in the United States and/or other countries.
Adobe, the Adobe logo, Acrobat, and the Acrobat logo are trademarks of Adobe Systems Incorporated.
Portions Copyright (c) 1996-2010, the PostgreSQL Global Development Group
Portions Copyright (c) 1994, The Regents of the University of California
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS
SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED
HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE
MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
All other trademarks and registered trademarks are the property of their respective holders.
Manual Title: KillSwitch Application Services Developer Guide for Companion Devices
Document Revision: 01
Publication Date: October 2018
Published by KillSwitch International Inc.
95 Bleep Lane
Beverly Hills, CA 90210 USA
©2007-2018 by KillSwitch International Inc. All rights reserved.
KillSwitch Dev Guide Confidential Property of KillSwitch International, Inc. 3
Table of Contents
Notices ..............................................................................................................................................2
Table of Contents ...............................................................................................................................3
Preface ..............................................................................................................................................4
Purpose of this Document ........................................................................................................................ 4
Audience ................................................................................................................................................... 4
Revision History......................................................................................................................................... 4
Customer Documentation ......................................................................................................................... 4
Contact Information .................................................................................................................................. 5
Chapter 1: Introduction ......................................................................................................................6
KillSwitch Overview ...........................................................................................................................6
Features ............................................................................................................................................6
Share Anywhere ......................................................................................... Error! Bookmark not defined.
Image Recall & Time Limit .......................................................................... Error! Bookmark not defined.
Available for everyone .............................................................................................................................. 6
Chapter 2: Use Cases ..........................................................................................................................7
Create New Image ..................................................................................................................................... 7
Image Information .................................................................................................................................... 7
Recall Image .............................................................................................................................................. 7
Chapter 3: API References ..................................................................................................................8
Create New Image ..................................................................................................................................... 8
Image Information .................................................................................................................................... 8
Recall Image .............................................................................................................................................. 9
Glossary........................................................................................................................................... 10
4 Confidential Property of KillSwitch International, Inc. KillSwitch Dev Guide
Preface
Purpose of this Document
This document is a guide for developers to use to successfully implement the KillSwitch app within their
systems.
Audience
The primary audience of this document is KillSwitch administrators, KillSwitch developers, and other
people implementing KillSwitch solutions.
The secondary audience of this document is companion developers, technical leads, architects, and
project managers working with KillSwitch or administering teams working with the KillSwitch platform.
Revision History
Table 1. Revision History of This Book
Version
Author
Description
01
Cristina Shannon
Initial draft
Customer Documentation
The most up-to-date versions of all KillSwitch technical publications are available on the KillSwitch
technical publications site, available directly from the Client Self Services Express site:
http://KillSwitchservice.lstatic.com/helpdesk
All documents are available in Adobe™ Acrobat™ (PDF) format, and require Acrobat Reader version 8.0
or later, available from the Adobe site at:
http://www.adobe.com
KillSwitch Dev Guide Confidential Property of KillSwitch International, Inc. 5
Contact Information
The following table lists the ways in which to contact KillSwitch International about support and service,
technical problems, suggestions, or questions.
Table 2. How to Contact KillSwitch
For help with...
Contact...
Technical problems or
questions such as System
failures or hardware RMAs
Technical Support Services
Submitting incident requests,
or checking the status of
existing requests or RMAs
Client Self Services
Express. Requires your
client ID and KillSwitch-
supplied password.
6 Confidential Property of KillSwitch International, Inc. KillSwitch Dev Guide
Chapter 1: Introduction
KillSwitch Overview
KillSwitch is a convenient, free app developed for sharing and unsharing photos instantly. You take the
photo, we add the kill switch to it. Use any platform to share your photos, but as soon as you need it to
disappear forever, just flick the kill switch.
Select the photo you want to share and chose how long it should be shared for. Once you’ve shared it to
other networking apps such as Facebook and Twitter, you can easily manage them through the
KillSwitch app.
You can choose to let your pictures expire, or remove them at anytime by manually flicking the kill
switch.
Features
Share Anywhere
We put a kill switch into your photos. The result is 100% JPEG compliant. You can share your photo via
email, text, Twitter, Facebook, WhatsApp, Hangouts, Slack, etc. And, it is easily shareable so your friends
can share the photo without having to download the KillSwitch app.
Image Recall & Time Limit
If you want to unshare your photo just flick the kill switch. Or, set your photo to expire automatically
after a certain amount of time. You can also make your photo available for only certain locations, a
certain number of views, collect viewer profile information, and original content provider subscription
or photo display context (branding).
Available for Everyone
Consumers can share links to photos with a kill switch by using our free App KillSwitch. Photos are
unshared after the chosen expiration time or when the kill switch is manually activated. App Developers
and Corporate Customer can integrate software iOS SDK into their own app and either share KillSwitchs
or directly our 100% JPEG compliant kill switch images.
KillSwitch Dev Guide Confidential Property of KillSwitch International, Inc. 7
Chapter 2: Use Cases
This section lists all relevant Use Cases for KillSwitch. Corresponding AVI calls for each Use Case can be
found in “Chapter 4: API References”.
Create New Image
Your user wants to begin uploading and sharing images to various apps that they can track,
manage, and erase from the web at any time.
Function Tree
1. Companion Device wants to create new image using KillSwitch
2. Companion Device asks the Application running on KillSwitch what image to embed kill
switch into
3. Application running on KillSwitch responds with what image it is uploading.
API Usage: Please see “Create New Image” in the next chapter, “API References”.
Image Information
Let’s say your user wants to find out some basic statistics regarding the photo they have
uploaded.
Function Tree
1. Companion Device wants to get image information using KillSwitch
2. Companion Device asks the Application running on KillSwitch to send image information
3. Application running on KillSwitch responds with image information.
API Usage: Please see “Image Information” in the next chapter, “API References”.
Recall Image
Your user has decided that the selfie they posted on Facebook with a bottle of Jack is a bit too
risqué, considering they are friends with their employer.
Function Tree
1. Companion Device wants to recall an image using KillSwitch
2. Companion Device asks the Application running on KillSwitch what image to recall
3. Application running on KillSwitch responds with the image to recall.
API Usage: Please see “Recall Image” in the next chapter, “API References”.
8 Confidential Property of KillSwitch International, Inc. KillSwitch Dev Guide
Chapter 3: API References
Create New Image
Parameters
image: image file in base 64
duration: shared duration in seconds in creating the Review Huffer (on HDD or SD-Card). If not
specified, it defaults to ‘0’ seconds delay (immediate).
embeddedPass: If set to 1 the password is embedded in the URL, so the viewer will not need to
decrypt the image.
Note: embeddedPass value can be set to 0 and the returned link will ask the viewer for the password
to decrypt the image. Do this if you are concerned about privacy and want to share the password
separately from the URL.
{
"method":"POST/v1/images/",
"id":50001,
"jsonrpc":"2.0",
"params":{
"ver":"1.0",
"image":me.jpg,
"duration":"259200",
"embeddedPass":"1",
}
}
Response
{
"id":50001,
"jsonrpc":"2.0",
"result":{
"link":"http://me.jpg/ ",
"imageId":1
}
}
Image Information
Parameters
views: Number of views of the image
likes: Number of likes hit in the website
thumbs: Number of thumbs hit in the website
smiles: Number of smiles hit in the website
remainingTime: Remaning time in seconds till image expires
link: KillSwitch to reshare
Note: if embeddedPass has been set to 0, you will need to remember the password as it will not be
stored in the server of the link.
Request
KillSwitch Dev Guide Confidential Property of KillSwitch International, Inc. 9
{
"method":"GET/v1/images/",
"imageid":50001,
"jsonrpc":"2.0",
"params":{
"link":”http://me.jpg/”,
}
}
Response
{
"id":50001,
"jsonrpc":"2.0",
"result": {
“views”: “32”,
“likes”:”17”,
“remainingTime”: “172800”,
“link”:”http://me.jpg/”,
}
}
Recall Image
Request
{
"method":"DELETE/v1/images/",
"imageid":50001,
"jsonrpc":"2.0",
"params":{
"link":”http://me.jpg/”,
}
}
Response
{
"id":50001,
"jsonrpc":"2.0",
"result": {
“code”:”200”,
}
}
10 Confidential Property of KillSwitch International, Inc. KillSwitch Dev Guide
Glossary
API
Application Programming Interface

Navigation menu