Profiles
From ePrize Developers Wiki
(→Standard Fields) |
|||
| (4 intermediate revisions not shown.) | |||
| Line 2: | Line 2: | ||
[[API Home Page]] | [[API Home Page]] | ||
| + | A profile holds a single consumer's information. It consists of a collection of key:value pairs (fields) where each key is unique within the profile. Much of the information within the profile is considered private or [[PII]] and will not be shared with an untrusted client. | ||
| + | |||
| + | == Profile Resources == | ||
<div class="api_table"> | <div class="api_table"> | ||
{| | {| | ||
|- | |- | ||
| [[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}.{webkey} | ||
|- | |- | ||
|} | |} | ||
| - | </div> | + | </div><br /> |
| - | + | ||
| - | + | ||
== Required Fields == | == Required Fields == | ||
| Line 38: | Line 42: | ||
* country | * country | ||
* locale | * locale | ||
| + | |||
| + | 'state', if configured in your API Key, should be sent as a 2 character USPS Abbreviation and the 'country' field sent as 'US'. Additionally, 'state' can be sent as an ISO 3166 string which includes the country code (e.g. US-FL, see: http://en.wikipedia.org/wiki/ISO_3166-2:US) without sending the country field. This is for United States only. If you API Key is configured for another country, you will receive additional instructions. | ||
Current revision
A profile holds a single consumer's information. It consists of a collection of key:value pairs (fields) where each key is unique within the profile. Much of the information within the profile is considered private or PII and will not be shared with an untrusted client.
Profile Resources
| Create profile | POST | /v1/{apikey}/profiles |
| Fetch profile by key | GET | /v1/{apikey}/profile({key})/{value} |
| Fetch profile | GET | /v1/{apikey}/profile/{uid}.{webkey} |
Required Fields
- One primary key field to identify a consumer. This key is called {promokey} in the API documentation.
Standard Fields
These are fields that are typically collected for a promotion. The specific field names will be agreed upon during creation of the API Key.
- first_name
- last_name
- age
- address1
- address2
- address3
- city
- state
- zip
- country
- locale
'state', if configured in your API Key, should be sent as a 2 character USPS Abbreviation and the 'country' field sent as 'US'. Additionally, 'state' can be sent as an ISO 3166 string which includes the country code (e.g. US-FL, see: http://en.wikipedia.org/wiki/ISO_3166-2:US) without sending the country field. This is for United States only. If you API Key is configured for another country, you will receive additional instructions.
