API Home Page

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 +
__NOINDEX__
'''New to ePrize Web Services?''' Read this first: [[Getting Started]]
'''New to ePrize Web Services?''' Read this first: [[Getting Started]]

Revision as of 21:17, 4 April 2011

__NOINDEX__ 

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

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

API Request and Response Overview

API Security Overview

API Events and Logging

Profiles

Create profile POST /v1/{apikey}/profiles
Fetch profile by key GET /v1/{apikey}/profile({key})/{value}
Fetch profile GET /v1/{apikey}/profile/{uid}

Games and Awards

Award sweepstakes entry POST /v1/{apikey}/game/{gameid}/sweeps
Award instant win token POST /v1/{apikey}/game/{gameid}/tokens
Fetch token GET /v1/{apikey}/game/{gameid}/token/{tokenid}
Redeem token POST /v1/{apikey}/game/{gameid}/token/{tokenid}
Fetch prize GET /v1/{apikey}/game/{gameid}/prize/{prizeid}

Mail

Send email POST /v1/{apikey}/email/{template-id}

CAPTCHA

Create CAPTCHA challenge POST /v1/{apikey}/captcha
Fetch CAPTCHA challenge GET /v1/{apikey}/captcha/{challenge-id}

Code Services

Validate and consume code POST /v1/{apikey}/code/{codeClass}/{code}

Contest

see: http://code.eprize.com/wiki/index.php/Contest_API

API Debugging

Output communication test GET /v1/{apikey}/test/communication
Input communication test POST /v1/{apikey}/test/communication
Input URL communication test PUT /v1/{apikey}/test/communication/{value}
Error response test PUT /v1/{apikey}/test/communication

ePrize Promotion Client Libraries

Retrieved from "https://code.helloworld.com/wiki/index.php/API_Home_Page"
Personal tools