Your Moodle version

General plugins (Local): Get Key

Maintained by Picture of Jai Gupta Jai Gupta, Picture of Pinky Sharma Pinky Sharma
Get API Key from (Usefull for vmchat, Virtual Class and onetoone plugin)
Moodle 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 3.0

Get API Key from (Usefull for vmchat and onetoone plugin)

Why is server used.

  1. server is used as a central point to interconnect all users (Teachers and Students).
  2. Messages from one user is transmitted to all other users.

Why can't Moodle or php scripts be used?

Moodle/php if used would be very slow and would demand lot of resources. Ever tried running Moodle's chat module with many users? You would also notice that Moodle recommends a chat daemon to run to reduce load on server. Even after daemon, it is slow. This is not Moodle's fault, it is way how PHP is, it is not correct tool for job.

Is server secure? What our privacy?

  1. server using secure SSL certificates and works only with secure protocols. This is security used by everyone for online credit card transactions. It is secure.
  2. No data is read by any human, transmits information from one user to other connected users and that's it.
  3. No data is ever saved on servers.

Are there any other services similar to


I still need to run it on our servers.

Running this and maintaining it on server is complex, we are in process of making it simpler to manage and plan to release it as open source. Once released, this information will be updated.

Potential privacy issues

Uses 3rd party services over secure (SSL) channel. No data is ever stored on server, it is only transmitted from one user to another (typically from teacher to students).


Screenshot #0
Screenshot #1
Screenshot #2


Picture of Jai Gupta
Jai Gupta (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Picture of Plugins bot
    Tue, Jul 1, 2014, 11:49 PM
    Thanks for sharing this plugin with the Moodle community. Some formal issues were detected and reported by our automated plugin checker tool. Please review all the plugin checker results and fix the issues mentioned, if possible. These changes are typically pretty easy to make but if you have any questions just let us know.

    Please resolve these formal issues so that the plugin code can be fully reviewed and approved by my human colleagues.
  • Picture of David Mudrák
    Thu, Jul 3, 2014, 9:59 PM
    Hi Jai. Thanks for sharing this plugin with the community. Your plugin defines capability 'local/getky:view' that 1) has a typo in the name and 2) is not used in the code itself. Can we either drop it (to use the moodle/site:config only) or fix the declaration and the usage of it.

    Note that instead of direct access to the config_plugins table, there is an API for that (get_config() and set_config()) recommended to use unless there is a good reason (which is not this case, AFAIK). This prevents issues with caching, among others.

    I think it would make sense to put all your three plugins into one set in this directory. Please provide a good name and description of such set (such as "VidyaMantra") and I will process it.

    For now, I am going to mark this plugin as needing more work until we get these issues resolved. Thanks for your patience with the review and approval process.
  • Picture of David Mudrák
    Thu, Jul 3, 2014, 10:05 PM
    OK, I changed my mind and am going to approve this now as it would block other plugins. Please let me know via messaging here and/or email on how to proceed with the set. Please address the raised issues in a future version of the plugin.
  • Picture of john Simpson
    Tue, Aug 5, 2014, 6:41 PM
    This plugin has caused me problems. Due to the fact of your demanded key it ruins evrything. Please fix this bug.
  • Picture of Jai Gupta
    Fri, Aug 8, 2014, 12:44 PM
    Hello John Simpson,

    I am impressed how you are able to comment/reply to all topics related to us.

    It is not demanding key, it would infact automatically generate API Key once you hit submit button. It is not a bug.

    It would be better if you would elaborate a bit more about challange you are facing.
  • Picture of Pinky Sharma
    Tue, Feb 17, 2015, 4:40 PM
    Hello Ravindra b,

    First, make sure you have installed the plugin by visiting Administration -> Notification area.
    After installation a new link Site Administration -> Get key under Administration block appears. Click on it . Here you will find a form to get API key which you need to fill/modify and then click on save changes. After submitting this you will get API key.

    It is supported to all Moodle 2.8 version.
  • Picture of Jose Mesa
    Wed, Jun 17, 2015, 4:22 AM
    good afternoon

    my question is , where I can enter my API key because the truth I have no idea where to enter that key to show me the graphics .

  • Picture of Pinky Sharma
    Wed, Jun 17, 2015, 12:38 PM
    Hello Jose Mesa,

    If you have Getkey installed, find the link under site administration block.
    Go to site administration-> Get Key. It will display page to create new API key or save existing key if any , as shown in above screenshot(3rd).

    Graph shows when you have some usage data with any of these applications (vmchat, onetoone, virtialclass). These applications using API key. The graph is the stat of usage of this key with these applications.
  • Picture of Jesse H
    Thu, Jul 2, 2015, 9:09 AM
    Hi There,
    I really enjoy the plugins you have made. I do have some issues with this key generation process. I have sensitive private student data on our moodle installation, how can i be certain that this plugin is not sending other data to your servers?

    I would much prefer if there was an option to host our own server and some other activation key process.
  • Picture of Jai Gupta
    Thu, Jul 2, 2015, 10:25 PM
    Hello Jesse,

    Thank you for feedback. I have updated plugin description to reflect your concerns.
    In short, server is used only to securily exchange messages between connected users. No data is ever saved or read by human. Data stays on server only for a fraction of second.

    Please reply back you have any further question.
  • Picture of Thiago Henrique Ornelas Costa
    Wed, Nov 18, 2015, 4:10 AM
    Hello . I tried to install the plugin getkey to use the VMchat in version 3.0 of Moodle and found an error in the location of the install folder and identify the plugin by the system. To solve the problem I had to take the variable $ plugin-> component = 'local_vmchat'; and replace with $ plugin-> component = 'local_getkey; I pasted this line of code in version.php File in the getkey package and finaly passed in validation to install this dependency and use vmchat! Please correct this error by adding the missing line of code to the next version of the package to 3.0! smile

  • Picture of Jai Gupta
    Thu, Nov 19, 2015, 7:29 PM
    Thank you Thiago. We will improve 3.0 smile
Please login to post comments