API Home Page
From ePrize Developers Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
| - | ePrize Web Services API uses a [[Wikipedia:Representational State Transfer|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, | + | [[Image:eprize-bricks.png|right|200px]] |
| + | |||
| + | ePrize Web Services API uses a [[Wikipedia:Representational State Transfer|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 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 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 " | + | * All responses to your actions use basic HTTP status codes such as "200 OK" and "403 Bad Request". |
* All responses include information on sub-resources and actions that may be performed. | * 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 responses use simple, regular media types that can be easily processed. | ||
* All GET and PUT actions are idempotent; most POST actions are not. | * All GET and PUT actions are idempotent; most 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 | + | 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&emdash;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. |
| - | + | == ePrize Web Services API == | |
| - | + | * [[API Request/Response Flow]] | |
| + | * [[API Security]] | ||
| + | * [[Promotions]] | ||
| + | * [[Profiles]] | ||
| + | * [[Games and Awards]] | ||
| + | * [[Mail]] | ||
| + | * [[API Debugging]] | ||
| - | == | + | == ePrize Promotion Client Libraries == |
| - | [[ | + | * [[Flash ActionScript 3.0 Promotion Client]] |
Revision as of 02:18, 2 March 2009
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 "403 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; most 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&emdash;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.
