Box.net APIv1 migration: Difference between revisions
m (small grammar fixes.) |
|||
| Line 8: | Line 8: | ||
After the upgrade, and without doing anything, all the files that were referenced from Box.net will still be accessible until the 14th of December. But it will not be possible to import new files until you configure the repository for the API version 2. | After the upgrade, and without doing anything, all the files that were referenced from Box.net will still be accessible until the 14th of December. But it will not be possible to import new files until you configure the repository for the API version 2. | ||
To configure, do | To configure, do the following: | ||
* Get the ''client ID'' and ''secret'' from your App at [https://app.box.com/developers/services Box.net] | * Get the ''client ID'' and ''secret'' from your App at [https://app.box.com/developers/services Box.net] | ||
| Line 20: | Line 20: | ||
You just need to configure the portfolio settings for the API version 2. | You just need to configure the portfolio settings for the API version 2. | ||
To configure, do | To configure, do the following: | ||
* Get the ''client ID'' and ''secret'' from your App at [https://app.box.com/developers/services Box.net] | * Get the ''client ID'' and ''secret'' from your App at [https://app.box.com/developers/services Box.net] | ||
| Line 28: | Line 28: | ||
==Requirement for HTTPS== | ==Requirement for HTTPS== | ||
Compared to the version 1, the API version 2 requires your website to use HTTPS for the authentication process. | |||
==End of alias/shortcuts== | ==End of alias/shortcuts== | ||
With the initial version of the API, we could use a direct link to a file | With the initial version of the API, we could use a direct link to a file as a reference in Moodle. But after the migration it is not possible any more, the repository will not support references any more. | ||
==/!\ To be done before the 14th of December 2013== | ==/!\ To be done before the 14th of December 2013== | ||
Revision as of 06:53, 7 November 2013
As of the 14th of December 2013, the API that Moodle uses to interact with the Box.net repository and Box.net portfolio is reaching its end of life. Box.net now recommends using their API version 2. There are a few implications related to the migration to their new API:
After upgrade to 2.6
Repository
After the upgrade, and without doing anything, all the files that were referenced from Box.net will still be accessible until the 14th of December. But it will not be possible to import new files until you configure the repository for the API version 2.
To configure, do the following:
- Get the client ID and secret from your App at Box.net
- Navigate to the repository settings: Administration block > Site administration > Plugins > Repositories > Manage instances
- In the dropdown of Box.net, select Enable and visible
- Then click Settings
- Enter the client ID and secret
Portfolio
You just need to configure the portfolio settings for the API version 2.
To configure, do the following:
- Get the client ID and secret from your App at Box.net
- Navigate to the repository settings: Administration block > Site administration > Plugins > Portfolios > Box.net
- Enter the client ID and secret
Requirement for HTTPS
Compared to the version 1, the API version 2 requires your website to use HTTPS for the authentication process.
End of alias/shortcuts
With the initial version of the API, we could use a direct link to a file as a reference in Moodle. But after the migration it is not possible any more, the repository will not support references any more.
/!\ To be done before the 14th of December 2013
We have provided a tool that will convert all the references you had in Moodle to real files (true copies). You can run this tool using either of the following:
- The Web interface, found at http://yoursite/repository/boxnet/migrationv1.php
- The CLI script, found at /repository/boxnet/cli/migrationv1.php
Please be aware that this tool could take several hours to run depending on the number of references and their size.
