Loyalty Web Services
From ePrize Developers Wiki
m |
|||
| (6 intermediate revisions not shown.) | |||
| Line 1: | Line 1: | ||
| - | + | ==Introduction== | |
This document provides an overview of the custom APIs that have been built for the HelloWorld Demo Loyalty program. There are additional APIs that are available in the program that require a more in-depth understanding of the architecture of the platform. | This document provides an overview of the custom APIs that have been built for the HelloWorld Demo Loyalty program. There are additional APIs that are available in the program that require a more in-depth understanding of the architecture of the platform. | ||
| - | API Endpoints | + | |
| + | '''API Endpoints''' | ||
/api/v1/ | /api/v1/ | ||
| - | + | # [[createMember]] | |
| - | + | # [[updateMember]] | |
| - | + | # [[getMember]] | |
| - | + | # [[forgotPassword]] | |
| - | + | # [[changePassword]] | |
| - | + | # [[submitCode]] | |
| - | + | # [[redeem]] | |
| - | + | # [[createIssue]] | |
| - | + | # [[createEmailReferral]] | |
| + | # [[currencyActivityStatement]] | ||
| + | # [[currencyBalance]] | ||
| + | # [[catalogItemList]] | ||
| + | |||
All API calls should be performed by an authenticated user. | All API calls should be performed by an authenticated user. | ||
| - | Authentication | + | '''Authentication''' |
| - | For the createMember call, the authenticated user will be an API user through | + | For the createMember call, the authenticated user will be an API user through basic authentication with system privileges to create a new user, and no other privileges. This user is set up as part of the initial program deployment please reach out to your HelloWorld representative to obtain these credentials. |
Authenticating a user for all other endpoints can be performed through basic authentication or through OAuth. OAuth is preferred and involves requesting an OAuth token for the user based on their Basic authentication credentials. Information on obtaining an OAuth token for a user is managed by submitting a Basic authentication request to the api/v1/authorize endpoint. Basic authentication requires submitting the users username and password as the authentication header. | Authenticating a user for all other endpoints can be performed through basic authentication or through OAuth. OAuth is preferred and involves requesting an OAuth token for the user based on their Basic authentication credentials. Information on obtaining an OAuth token for a user is managed by submitting a Basic authentication request to the api/v1/authorize endpoint. Basic authentication requires submitting the users username and password as the authentication header. | ||
| + | |||
| + | Please note that the authorize end point is not detailed in this document. Documentation for that end point can be obtained via your HelloWorld representative. | ||
Current revision
Introduction
This document provides an overview of the custom APIs that have been built for the HelloWorld Demo Loyalty program. There are additional APIs that are available in the program that require a more in-depth understanding of the architecture of the platform.
API Endpoints /api/v1/
- createMember
- updateMember
- getMember
- forgotPassword
- changePassword
- submitCode
- redeem
- createIssue
- createEmailReferral
- currencyActivityStatement
- currencyBalance
- catalogItemList
All API calls should be performed by an authenticated user.
Authentication
For the createMember call, the authenticated user will be an API user through basic authentication with system privileges to create a new user, and no other privileges. This user is set up as part of the initial program deployment please reach out to your HelloWorld representative to obtain these credentials.
Authenticating a user for all other endpoints can be performed through basic authentication or through OAuth. OAuth is preferred and involves requesting an OAuth token for the user based on their Basic authentication credentials. Information on obtaining an OAuth token for a user is managed by submitting a Basic authentication request to the api/v1/authorize endpoint. Basic authentication requires submitting the users username and password as the authentication header.
Please note that the authorize end point is not detailed in this document. Documentation for that end point can be obtained via your HelloWorld representative.
