emphasised version 2 deactivation date
← Older revision
Revision as of 13:03, June 12, 2016
(One intermediate revision by one user not shown)
Line 4:
Line 4:
==Version 3 of the API==
==Version 3 of the API==
−
On 21 May, 2016, version 3 of Habitica's API was released. All new third-party software should use it and all existing software should be updated to use it. Version 2 will continue to work until 15 July, 2016, but after that date, any software that still uses it will stop working.
+
On 21 May, 2016, version 3 of Habitica's API was released. All new third-party software should use it and all existing software should be updated to use it. '''On 15 July, 2016, version 2 will be deactivated and any software that still uses it will stop working.'''
The following resources exist to help you update any tools you have written or create new ones:
The following resources exist to help you update any tools you have written or create new ones:
*[https://habitica.com/apidoc/ Habitica V3 API Documentation]
*[https://habitica.com/apidoc/ Habitica V3 API Documentation]
*[http://devs.habitica.com/ The Forge] - Habitica's official blog for Blacksmiths:
*[http://devs.habitica.com/ The Forge] - Habitica's official blog for Blacksmiths:
+
**[http://devs.habitica.com/api-v2-deprecation-notice/ API v2 Deprecation Notice]
+
**[http://devs.habitica.com/api-v2-v3-migration-guide/ API v2 -> v3 Migration Guide]
**[http://devs.habitica.com/overview-of-changes-in-version-3-of-the-api/ Overview of Changes in Version 3 of the API] - the major differences between versions 2 and 3
**[http://devs.habitica.com/overview-of-changes-in-version-3-of-the-api/ Overview of Changes in Version 3 of the API] - the major differences between versions 2 and 3
−
**[http://devs.habitica.com/api-v2-v3-migration-guide/ API v2 -> v3 Migration Guide]
−
**[http://devs.habitica.com/api-v2-deprecation-notice/ API v2 Deprecation Notice]
*[https://habitica.com/#/options/groups/guilds/68d4a01e-db97-4786-8ee3-05d612c5af6f Aspiring Coders] guild for asking questions and seeking help
*[https://habitica.com/#/options/groups/guilds/68d4a01e-db97-4786-8ee3-05d612c5af6f Aspiring Coders] guild for asking questions and seeking help
*[https://github.com/HabitRPG/habitrpg/issues Habitica's GitHub repository] for assistance and reporting problems with the API (e.g., errors or confusing documentation)
*[https://github.com/HabitRPG/habitrpg/issues Habitica's GitHub repository] for assistance and reporting problems with the API (e.g., errors or confusing documentation)
Line 17:
Line 17:
===Errors in the API Documentation===
===Errors in the API Documentation===
−
If you find errors in the API documentation, report them in a GitHub issue or submit a pull request for them. You can expect them to be fixed quickly, but it might take a few days before we can deploy the fix to the website. Current known or suspected errors are:
+
If you find errors in the API documentation, report them in a GitHub issue or submit a pull request for them. You can expect them to be fixed quickly, but it might take a few days before we can deploy the fix to the website. There are currently no known errors.
−
−
*The URL for requesting data from a single task is<br /><code>https://habitica.com/api/v3/tasks/:taskId</code> not<br /> <code>https://habitica.com/api/v3/task/:taskId</code>
−
*'''Challenge - Get challenges for a group''' is<br /><code>https://habitica.com/api/v3/challenges/group/:groupId</code> not<br /> <code>https://habitica.com/api/v3/challenges/group/group:Id</code>
===Using the API===
===Using the API===