1. Home
  2. ManyCam for Education
  3. Features
  4. ManyCam User Management API
  1. Home
  2. Features
  3. ManyCam User Management API

ManyCam User Management API

User Management API is used to manage ManyCam activation sharing in certain types of ManyCam subscriptions. To use the API, you will require an Enterprise or Education subscription (learn more about subscriptions here), and a ManyCam account.

Getting started

API management involves sending POST requests that contain certain commands. To start using the API, you will need to get an authorization token using the “authorize” command. The lifetime of the token is one week. The token will enable you to run other commands.

The next step will be requesting the information about your subscription(s) using the “get_information” command. This will enable you to share activations with other users and take them back. Activations can be shared to an email only.

Authorization

The “authorize” command returns an authorization token and grants access to other API management commands.

Json authorization request:

{
    "access_token" : "",
    "command" : {
        "type" : "authorize",
        "data" : {
          "login" : "<your nickname or email>",
          "password" : "<your password>" 
        }
    }
}

Get information

This command returns the information about your subscription(s).
The “data” array will return a full list of your subscriptions with the following parameters listed in “activations”:

  • “total_activations” indicates the total number of activations available in this type of subscription.
  • “number_of_your_activated_clients” is the number of devices activated under your account.
  • “number_shared_activations” is the number of activations being shared.
  • “available_activations” is the number of activations available for sharing.

“users” contains a list of users whom you already shared activations with.

Json request:

{
    "access_token" : "<your token>",
    "command" : {
        "type" : "get_information",
        "data" : {
        }
    }
}

Share activations

To share activations, specify the email and the number of activations to be shared.

Json request:

{
    "access_token" : "<your token>",
    "command" : {
        "type" : "share_activation",
        "data" : {
          "subscriptions":[
            {
                "subscription_id" : 10,
                "activation_data" : [
                    {
                        "email" : "testemail",
                        "activations" : "1" 
                    },
                    {
                        "email" : "testemail_2",
                        "activations" : "1" 
                    },
                    ...
                ]
            },
            {
                "subscription_id" : 20,
                "activation_data" : [
                    {
                        "email" : "testemail_3,
                        "activations" : "1" 
                    }
                ]
            }
          ]
        }
    }
}

Error response:

{
    "command_type":"share_activation",
    "result":{
        "status":"error",
        "data":{
            "10":{"status":"error","message":["testemail- Incorrect email","testemail_2 - Incorrect email"]},
            "20":{"status":"success"}
        }
    }
}

Success response:

{
    "command_type":"share_activation",
    "result":{
        "status":"success",
        "data":[]
    }
}

Take Back Activation

If the “subscriptions” array is empty, you will take back all activations for all subscriptions.

Json request:

{
     "access_token" : "<your token>",
     "command" : {
         "type" : "take_back_activation",
         "data" : {
             "subscriptions":[

             ]
         }
     }
 }

If “subscriptions” is specified, you will take back all activations of this subscription.

Json request:

{
     "access_token" : "<your token>",
     "command" : {
         "type" : "take_back_activation",
         "data" : {
             "subscriptions":[
                 {"subscription_id" : 10},{"subscription_id" : 20}
             ]
         }
     }
 }

To take back all activations of a certain subscription from a certain email.

Json request:

 {
    "access_token" : "<your token>",
    "command" : {
        "type" : "take_back_activation",
        "data" : {
          "subscriptions":[
            {
                "subscription_id" : 10,
                "emails" : ["email_1","email_2",...]
            },
            {
                "subscription_id" : 20,
                "emails" : ["email_1"]
            }
          ]
        }
    }
}

Success response:

{
    "command_type":"take_back_activation",
    "result":{
        "status":"success",
        "data":[]
    }
}


Updated on June 20, 2019

Was this article helpful?

Related Articles