Menu

Tutorial: How to use Knox Deployment Program REST APIs

Follow these steps to get started with the KDP APIs.

  1. Sign up for the Knox Deployment Program.
  2. Request access to the Knox Cloud APIs service.
  3. Generate your unique Client Identifier and download your key pair from the portal, Knox Cloud APIs.
  4. Create your access token.
  5. Upload customer devices.
  6. Check the status of the upload.
  7. Delete customer devices.

Step 1: Sign up for the Knox Deployment Program

  1. Register for a Samsung Knox account as a reseller. Follow these steps on getting access to the KDP Portal from the KDP Portal admin guide:

    a. Select APPLY NOW to submit your Knox Deployment Program application.

    b. A screen displays cautioning that once you have registered from the Knox Deployment Program (KDP) you are not able to register for Knox IT solutions such as Knox Configure (KC), Samsung SDS IAM & EMM, Knox Mobile Enrollment (KME), and Knox Manage. If satisfied with those conditions, select CONTINUE to proceed.

    c. Enter your business email address to Register for Samsung Knox web portal. Select NEXT to continue.

    d. If you need to create a Samsung account, complete the required fields and select Continue to proceed. You will receive an email verification screen prompting you whether the provided credentials are correct. Select DONE to proceed if the listed email address is correct. If not correct, follow the steps listed within the email verification screen.

  2. Login to your account through the KDP Portal within the Samsung Knox dashboard.
  3. Select LAUNCH CONSOLE to open the KDP Portal console.
  4. Find your resellerId in the main dashboard of the console.

Step 2: Request access to the Knox Cloud APIs service

Apply for Knox Cloud API access to the cloud REST service by contacting your local Samsung representative or raising a support ticket. This provides portal access to the Knox Cloud APIs to generate the authentication token sent in the header of a request. For more information, see the Knox Web Services overview.

Step 3: Generate your unique Client Identifier and download your key pair from the portal, Knox Cloud APIs

Download your unique key pair and clientIdentifier from the Knox Cloud APIs. The clientIdentifier can be re-generated through the console, but must be bound to the downloaded certificate, as described in the Knox Web Services overview .

Step 4: Create your access token

Call the access token REST API to generate your access token x-knox-apitoken.

Note: For security reasons, the access token has an expiry of 30 minutes. Regenerate as specified in the Knox Web Services overview.

Step 5: Upload customer devices

Now that you have your resellerId and access token x-knox-apitoken, asynchronously register a customer's device by calling the Upload Devices API.

    PUT /kcs/v1/rp/devices/upload HTTP/1.1
    host: https://us-kcs-api.samsungknox.com
    content-type: application/json
    x-knox-apitoken: "<insert-token-step-4>"

    {
        "customerId": "string",
        "resellerId": "string",
        "transactionId": "string",
        "devices": [
        "string"
        ],
        "type": "IMEI",
        "orderNo": "string",
        "orderTime": 1542405655,
        "vendorId": "string"
    }

Step 6: Check the status of the upload

  • Next, use the List Device Transaction Status API to check if the upload was successful.

        GET /kcs/v1/rp/devices/status?resellerId="<your-reseller-id>"&customerId="<your-customer-id>"; HTTP/1.1
        host: https://us-kcs-api.samsungknox.com
        content-type:application/json
        x-knox-apitoken: "<insert-token-step-4>"
  • Optionally, you can use the List Devices API to view all successfully loaded devices for a customer.

        GET /kcs/v1/rp/devices?resellerId="<your-reseller-id>"&pageSize=100&pageNum=0
        host: https://us-kcs-api.samsungknox.com
        content-type:application/json
        x-knox-apitoken: "<insert-token-step-4>"
  • Optionally, you can also access the list of customers in your portal by using the List Reseller's Customers API.

        GET /kcs/v1/rp/customers/list?resellerId="%lt;your-reseller-id>" HTTP/1.1
        content-type:application/json
        x-knox-apitoken: "<insert-token-step-4>"
        host: https://us-kcs-api.samsungknox.com

Step 7: Delete customer devices

Lastly, if you want to remove a device, you can call the Delete Devices API.

    PUT /kcs/v1/rp/devices/delete HTTP/1.1
    host: https://us-kcs-api.samsungknox.com
    content-type:application/json
    x-knox-apitoken: "<insert-token-step-4>"

    // Using Remove Transaction ID
    {
        "customerId": "string",
        "resellerId": "string",
        "transactionId": "string",
        "removeTransactionId": "string",
        "type": "string",
        "vendorId": "string"
    }

    // Using Device List
    {
        "customerId": "string",
        "resellerId": "string",
        "transactionId": "string",
        "devices": [
        "string"
        ],
        "type": "string",
        "vendorId": "string"
    }

As a participating KDP reseller, you are responsible for uploading devices purchased by your customers for access to Knox Mobile Enrollment, Knox Configure, and other Knox cloud services. The association between the reseller and the customer is automatically created during a device’s first upload based on their customerId.