API Home Page

From ePrize Developers Wiki

Revision as of 15:09, 8 April 2011 (edit) Wikiadmin (Talk | contribs) ← Previous diff		Revision as of 15:13, 8 April 2011 (edit) (undo) Wikiadmin (Talk | contribs) Next diff →
Line 32:		Line 32:
	|-		|-
	| [[Output communication test]]		| [[Output communication test]]
-	| GET /v1/{apikey}/test/communication	+	| GET
-	|	+	| /v1/{apikey}/test/communication
	|-		|-
	| [[Input communication test]]		| [[Input communication test]]
-	| POST /v1/{apikey}/test/communication	+	| POST
-	|	+	| /v1/{apikey}/test/communication
	|-		|-
	| [[Input URL communication test]]		| [[Input URL communication test]]
-	| PUT /v1/{apikey}/test/communication/{value}	+	| PUT
		+	| /v1/{apikey}/test/communication/{value}
	|		|
	|-		|-
	| [[Error response test]]		| [[Error response test]]
-	| PUT /v1/{apikey}/test/communication	+	| PUT
-	|	+	| /v1/{apikey}/test/communication
	|-		|-
	|}		|}
Line 54:		Line 55:
	|-		|-
	| [[Create profile]]		| [[Create profile]]
-	| POST /v1/{apikey}/profiles	+	| POST
-	|	+	| /v1/{apikey}/profiles
	|-		|-
	| [[Fetch profile by key]]		| [[Fetch profile by key]]
-	| GET /v1/{apikey}/profile({key})/{value}	+	| GET
-	|	+	| /v1/{apikey}/profile({key})/{value}
	|-		|-
	| [[Fetch profile]]		| [[Fetch profile]]
-	| GET /v1/{apikey}/profile/{uid}	+	| GET
-	|	+	| /v1/{apikey}/profile/{uid}
	|-		|-
	|}		|}
Line 72:		Line 73:
	|-		|-
	| [[Create CAPTCHA challenge]]		| [[Create CAPTCHA challenge]]
-	| POST /v1/{apikey}/captcha	+	| POST
-	|	+	| /v1/{apikey}/captcha
-	|-	+
	|-		|-
	| [[Fetch CAPTCHA challenge]]		| [[Fetch CAPTCHA challenge]]
-	| GET /v1/{apikey}/captcha/{challenge-id}	+	| GET
-	|	+	| /v1/{apikey}/captcha/{challenge-id}
	|-		|-
	|}		|}
Line 87:		Line 87:
	|-		|-
	| [[Award sweepstakes entry]]		| [[Award sweepstakes entry]]
-	| POST /v1/{apikey}/game/{gameid}/sweeps	+	| POST
-	|	+	| /v1/{apikey}/game/{gameid}/sweeps
	|-		|-
	| [[Award token|Award instant win token]]		| [[Award token|Award instant win token]]
-	| POST /v1/{apikey}/game/{gameid}/tokens	+	| POST
-	|	+	| /v1/{apikey}/game/{gameid}/tokens
	|-		|-
	| [[Fetch token]]		| [[Fetch token]]
-	| GET /v1/{apikey}/game/{gameid}/token/{tokenid}	+	| GET
-	|	+	| /v1/{apikey}/game/{gameid}/token/{tokenid}
	|-		|-
	| [[Redeem token]]		| [[Redeem token]]
-	| POST /v1/{apikey}/game/{gameid}/token/{tokenid}	+	| POST
-	|	+	| /v1/{apikey}/game/{gameid}/token/{tokenid}
	|-		|-
	| [[Fetch prize]]		| [[Fetch prize]]
-	| GET /v1/{apikey}/game/{gameid}/prize/{prizeid}	+	| GET
-	|	+	| /v1/{apikey}/game/{gameid}/prize/{prizeid}
	|-		|-
	|}		|}
Line 113:		Line 113:
	|-		|-
	| [[Send email]]		| [[Send email]]
-	| POST /v1/{apikey}/email/{template-id}	+	| POST
-	|	+	| /v1/{apikey}/email/{template-id}
	|-		|-
	|}		|}
Line 123:		Line 123:
	|-		|-
	| [[Validate and consume code]]		| [[Validate and consume code]]
-	| POST /v1/{apikey}/code/{codeClass}/{code}	+	| POST
-	|	+	| /v1/{apikey}/code/{codeClass}/{code}
	|-		|-
	|}		|}
Line 132:		Line 132:
	{|		{|
	|-		|-
-	| see: http://code.eprize.com/wiki/index.php/Contest_API	+	| [[Enter Contest]]
-	|	+	| 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}/contest/entry
		+	|-
		+	| [[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
		+	|-
		+	| [[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}/contest/history
	|}		|}
	</div>		</div>

---

Revision as of 15:13, 8 April 2011

New to ePrize Web Services? Read this first: Getting Started

ePrize Web Services API uses a REST architecture for communication between your client and the ePrize servers. This is the same architecture used by the web, so you can explore the API with a web browser. While exploring the API, its basic features become clear:

• All URLs represent resources available to you. URLs are never actions.
• All actions on resources are basic HTTP methods such as GET, POST and PUT.
• All responses to your actions use basic HTTP status codes such as "200 OK" and "400 Bad Request".
• All responses include information on sub-resources and actions that may be performed.
• All responses use simple, regular media types that can be easily processed.
• All GET and PUT actions are idempotent; POST actions are not.

These features come at a cost however: the API consists of very small building blocks that do not directly provide the promotion services you expect in an ePrize promotion. For example, game plays are not automatically awarded upon login—there isn't even a login call! If you want to build clients using these more specific promotion features, you must use a client library. A library assembles the small building blocks into bigger features that you can reuse when building your promotion.

It is important to note that all communication to and from the ePrize Web Services API uses UTF-8 encoding.

ePrize Web Services API