Menu

Before you begin

This section provides a set of instructions to follow if you're a new developer who wants to use the Knox E-FOTA service. If you're new to developing for Knox E-FOTA, read through this section to set up before you begin.

Terms

  • Corp ID—This identifies MDM customers for Knox E-FOTA and their enterprise devices. A corp ID follows the following format: "mdmId/customerId/groupId", and is provided by Software license management (SLM).
  • MDM ID—This identifies your company among other partners in our Knox Partner Program. The mdmId is a 10-character alphanumeric string. For example, "d1e2f3g4h5" which represents your vendor ID in Knox Partner Program.
  • Customer ID—This identifies one of your enterprise customers registered to use the Knox E-FOTA service and is provided by Software license management (SLM). The customerId is a hyphen-separated 32-character hexadecimal string. For example, "EEEE4444-FF55-AA66-BB77-CCCCCC888888".
  • License—This identifies the Knox E-FOTA license purchase order and tracks customer usage of the Knox E-FOTA service for billing purposes. During development, you use a Knox E-FOTA trial license (valid for 3 months, maximum 100 devices). During commercial deployment this license is purchased. Format is: "EFOTA1-fff555-ggg666-hh77".
  • Client ID—Used to generate an OAuth 2.0 access token to authenticate your identity in REST API calls. A hyphen-separated 32-character hexadecimal string, for example, "aaaa1111-bb22-cc33-dd44-eeeeee555555". Go to view your license keys to obtain your license key number, and use the license key number as your client ID.
  • Client secret—Used to generate an OAuth 2.0 access token to authenticate your identity in REST API calls. A hyphen-separated 32-character hexadecimal string, for example, "bbbb2222-cc33-dd44-ee55-ffffff666666".Go to view your license keys to obtain your client secret.
  • Sales code—The consumer software customization code for the device carrier. Previously called carrierCode in Knox E-FOTA version 1. Format example: "ABC".

Requirements

  1. Knox Partner Program account—After creating a Samsung Account, you will have a Knox Partner Program developer account. After, you must apply to upgrade to a Knox Partner Program account.
  2. Knox E-FOTA REST API Key—Before using Knox E-FOTA APIs, you must first request credentials for Knox E-FOTA to obtain the REST API key, which expires after 1 year during trial. Note that you will need to be a partner before being able to do this. After your request is confirmed, you will obtain a client_id and client_secret.
  3. Corp ID Knox E-FOTA license—After requesting credentials, you must then contact us to request a Corp ID and Knox E-FOTA license. During commercial deployment, this license is purchased, but while trying Knox E-FOTA you will receive a development trial license through an email sent by Software license management (SLM), which expires after 3 months. The email will have the following information: license, CorpId, mdmId, and customerId.
  4. Obtain enterprise device information—When registering enterprise devices to Knox E-FOTA, you first need to obtain the salesCode and serialNumber.

Create a Samsung Account

If you haven't already created a Samsung Account on the Knox Partner Program portal, follow the steps below:

  1. Go to the Knox Partner Program portal and click BECOME A PARTNER.
  2. Enter your work email address.
  3. In the login page, click Sign up here.

  4. Click the links available and read them carefully. Check the boxes and click Agree to acknowledge you have read and agree to the following terms.

  5. Provide the necessary information for the required fields and click NEXT to register for the Samsung Account.

  6. In your email inbox, open the confirmation email for the Samsung Account and click the verification link.

You have now successfully created a developer account on Knox Partner Program. Proceed to sending a request to become a Knox Partner Program partner.

Request to upgrade to Knox Partner Program partner

NOTE—Only partner accounts can have access to the Knox E-FOTA service. New developers must first enrol through the Knox Partner Program portal .

To become a Knox Partner Program partner, follow the steps below:

  1. Log into the Knox Partner Program portal with your developer account.
  2. Submit a Knox Partner Program upgrade form to upgrade from developer to partner status.

Once you've created a partner account, you're ready to request a Knox E-FOTA key.

Request credentials for Knox E-FOTA

A REST API key is required to generate an OAuth 2.0 access token to authenticate your identity in REST API calls. Once you're a Knox Partner Program partner, you can obtain a development test REST API key after requesting credentials through Knox Partner Program. During commercial deployment, you can obtain a commercial REST API key after purchasing a Knox E-FOTA license.

NOTE—Development test credentials are valid for 1 year after the issued date. For more details, read more About License Keys.

Send a request for credentials

  1. Log into your Knox Partner Program partner account.
  2. Go to your dashboard and click License Keys > My License Keys.
  3. Click Add License Key > Get a License Key.
  4. Click the Knox E-FOTA REST API Key tab.
    NOTE— If you don't see this tab, your approval to upgrade may still be pending.
  5. Fill out the request form.
    • Key request title—For example "Knox E-FOTA REST API key request".
    • Customer name—Enter the company's name.
    • Customer location—Enter the company's country.
    • Customer website—Enter the enterprise website.
    • Key alias—If your company has multiple licenses, it's helpful to enter a key alias to differentiate between multiple keys. This assigns a name label to the REST API key to help you identify a specific key when your enterprise possesses multiple keys.
    • Customer industry (optional)—Enter the enterprise industry category.
    • Comments (optional)—Enter any additional comments here.
  6. Click Request Key.

View your Knox E-FOTA REST API keys

Once you are approved to use the Knox E-FOTA service, you will receive an email. Click RETRIEVE Knox E-FOTA KEY to view your licenses.

Alternatively, follow the steps below:

  1. Log into your Knox Partner Program partner account.
  2. Go to your dashboard and click License Keys > My license keys.
  3. Click on your license key alias to view the license details and get:
    • license key number—A hyphen-separated 32-character hexadecimal string, for example,bbbb2222-cc33-dd44-ee55-ffffff666666.
    • client secret—A hyphen-separated 32-character hexadecimal string, for example,bbbb2222-cc33-dd44-ee55-ffffff666666.

You will use your license key number as your client_id with your client_secret to generate OAuth 2.0 access tokens, which are used to authenticate your identity in REST API calls.

Request a Corp ID and Trial Knox E-FOTA license

Prior to your Knox E-FOTA solution going live, enterprises must first purchase a license. While you are still developing your Knox E-FOTA solution however, you use a development license to simulate enterprise customers with paid licenses.

NOTE—The trial Knox E-FOTA license and Corp ID expires after 3 months. For more details, read more About License Keys.

To Request a Corp ID and trial Knox E-FOTA license, you will need to submit a ticket through Salesforce by following the steps below:

  1. Log into your Knox Partner Program partner account.
  2. Go to your dashboard.
  3. Click Support > Technical Support.
  4. In the topic drop-down menu, select Knox E-FOTA inquiry.
  5. Fill out the mandatory fields. In the Message field, ensure that you include a request for the following information in the description:
    • Corp ID—This identifies MDM customers for Knox E-FOTA and their enterprise devices. A corp ID follows the following format: "mdmId/customerId/GroupId", and is provided by Software license management (SLM).
    • Development test key for Knox E-FOTA—This identifies the Knox E-FOTA license purchase order and tracks customer usage of the Knox E-FOTA service for billing purposes. During development, you use a Knox E-FOTA trial license (valid for 3 months, maximum 100 devices).
  6. Click Finish.
  7. After your request has been reviewed and approved by SLM, you will receive an email with your Corp ID, customer ID, MDM ID and Knox E-FOTA development key in the following email:

    After obtaining the required information, you'll be ready to begin developing your web server code in the tutorials section of this guide.

Purchase a Knox E-FOTA license

Once you're ready to purchase a license, there are two ways to purchase a license:

NOTE—Make sure that you're logged in as a partner or apply to become a Knox Partner Program partner. If you login with a developer account, you will be re-directed to the Contact Us page.

You encode this info into REST API calls to the Knox E-FOTA server, and also in the Android API call used to set the allowed firmware version on a device.