Contest API
From ePrize Developers Wiki
| (5 intermediate revisions not shown.) | |||
| Line 4: | Line 4: | ||
== Contest Overview == | == Contest Overview == | ||
| - | The | + | The HelloWorld contest service provides an API for hosting an essay, photo, or video contest, with submission, rating, and voting capabilities. Your [[API Key|API key]] must be configured for contest for these resources to work properly. |
Contests can work on text fields (essays) or binary files (images). To operate on contest entries, the following resources are provided. Entries are associated with [[Create profile|profiles]], so a profile must be created first. | Contests can work on text fields (essays) or binary files (images). To operate on contest entries, the following resources are provided. Entries are associated with [[Create profile|profiles]], so a profile must be created first. | ||
| Line 10: | Line 10: | ||
<div class="api_table"> | <div class="api_table"> | ||
{| | {| | ||
| + | |- | ||
| + | | [[Photo Upload Key|Get Key for Photo Upload]] | ||
| + | | POST | ||
| + | | /v1/{apikey}/contest/photo_upload_key | ||
|- | |- | ||
| [[Enter Contest|Create Contest Entry]] | | [[Enter Contest|Create Contest Entry]] | ||
| Line 21: | Line 25: | ||
| [[Get All Contest Entries for a Profile]] | | [[Get All Contest Entries for a Profile]] | ||
| GET | | GET | ||
| - | | /v1/{apikey}/profile/{profileId}/contest/entry | + | | /v1/{apikey}/profile/{profileId}.{webkey}/contest/entry |
|} | |} | ||
</div> | </div> | ||
| Line 70: | Line 74: | ||
| [[Fetch Profile Contest History]] | | [[Fetch Profile Contest History]] | ||
| GET | | GET | ||
| - | | /v1/{apikey}/profile/{profileId}/contest/history | + | | /v1/{apikey}/profile/{profileId}.{webkey}/contest/history |
|} | |} | ||
</div> | </div> | ||
Current revision
Contest Overview
The HelloWorld contest service provides an API for hosting an essay, photo, or video contest, with submission, rating, and voting capabilities. Your API key must be configured for contest for these resources to work properly.
Contests can work on text fields (essays) or binary files (images). To operate on contest entries, the following resources are provided. Entries are associated with profiles, so a profile must be created first.
| Get Key for Photo Upload | POST | /v1/{apikey}/contest/photo_upload_key |
| Create Contest Entry | POST | /v1/{apikey}/contest/entry |
| Fetch a Contest Entry | GET | /v1/{apikey}/contest/entry/{entryId} |
| Get All Contest Entries for a Profile | GET | /v1/{apikey}/profile/{profileId}.{webkey}/contest/entry |
After an entry is created, a number of other resources can modify its metadata by voting or rating the entry. Votes and ratings are subject to certain limits which will be configured in your API key. A tattle is a way for users to inform you of a photo that they disapprove of.
| Rate a Contest Entry | POST | /v1/{apikey}/contest/entry/{entryId}/rate |
| Tattle on a Contest Entry | POST | /v1/{apikey}/contest/entry/{entryId}/tattle |
| Vote on a Contest Entry | POST | /v1/{apikey}/contest/entry/{entryId}/vote |
| Send a Contest Entry Link | POST | /v1/{apikey}/contest/entry/{entryId}/send_a_link |
An entry gallery can be created by using the gallery resource and parsing the resulting XML (or JSON) to create a paginated gallery of any approved entries.
| Browse Contest Gallery | GET | /v1/{apikey}/contest/gallery |
| Fetch Contest Leaderboard | GET | /v1/{apikey}/contest/most-popular |
| Fetch Profile Contest History | GET | /v1/{apikey}/profile/{profileId}.{webkey}/contest/history |
