Get started

This guide explains how to integrate Knox MSP Portal API into your web services to remotely manage Knox cloud services for your enterprise customers.

Before you begin

Before you start the integration process, ensure you have the following:

• A valid Samsung Knox partner account
• Access to the Knox Developer Portal
• Basic knowledge of REST APIs and authentication mechanisms
• A development environment capable of making HTTP requests

Step 1 — Complete registration for the Knox MSP Program

To access Knox MSP Portal, you must first register as a Knox partner and then enroll in the Knox MSP Program as follows:

1. Register for a Knox partner account. You’ll receive an email once your request is approved.

2. Sign in to your account, and register for the Knox MSP Program.

Step 2 — Request Cloud Apps access

To use the Knox MSP Portal API, you need access to the Cloud Apps feature in the Knox Developer Portal. For relevant steps, see Register a Cloud App.

Step 3 — Generate an access token

Once Cloud Apps access is approved, generate an access token for API authentication. For relevant steps, see Generate an access token. Include this access token in the header of all Knox MSP Portal API requests.

Step 4 — Verify your integration

Make a test call to any endpoint in the Knox MSP Portal API to ensure your integration was successful. For example, try retrieving information about all managed customers using GET /managedCustomers:

curl --location 'https://api.samsungknox.com/msp/v1/managedCustomers' \
     --header 'Authorization: Bearer {ACCESS_TOKEN}' \
     --header 'Content-Type: application/json'

Remember to use your actual access token instead of the {ACCESS_TOKEN} placeholder. A successful response will look like this:

{
  "totalCount": "2",
  "customers": [
    {
      "customerId": "1111111111",
      "email": "johnny@john.com",
      "officeNumber": "111 111 1111",
      "companyName": "Company ABC",
      "companySize": "Medium",
      "industry": "COMMUNICATIONS",
      "street1": "123 Main Street",
      "city": "Chicago",
      "stateOrProvince": "Illinois",
      "zipCode": "60601",
      "country": "US",
      "website": "www.companyabc.com",
      "managementType": "JointlyManaged",
      "managedServices": [
        {
          "service": "KnoxManage",
          "status": "Active"
        }
      ],
      "optional": {
        "deviceCountExclKM": 0,
        "deviceCountKM": 10,
        "modified": "2023-06-15T14:30:00Z",
        "created": "2023-06-01T10:15:00Z"
      }
    }
  ]
}

Troubleshooting

If you encounter issues with your integration, check these common problems:

1. Authentication errors: Verify that your access token is valid and properly formatted in the Authorization header. Ensure that the token hasn’t expired, and that it was generated with the correct client credentials. Use tools like cURL to test your authentication.

2. Permission errors: Make sure your application has the required scopes for the operations you’re trying to perform. If necessary, update your app’s permissions in the Knox Developer Portal.

3. Invalid parameters: Ensure all required parameters are provided in the correct format according to the API reference. Review error messages returned by the API for specific details on what might be wrong.

4. Network issues: Verify that your network connection is stable and that there are no firewall restrictions blocking API requests. Test connectivity to the API endpoint, and confirm that your requests are not being blocked by corporate firewalls or proxies.

5. Data validation: Ensure that the data you’re sending to the API meets all validation requirements. Check for issues like invalid email formats, incorrect country codes, or missing required fields.

If you still need help, create a support ticket. Include detailed information about the error, including the endpoint you were calling, request/response details (with sensitive data redacted), and any error codes received.