Partner Server

This is a private Node.js Express app that hosts the Partner Server https://partner.[domain]. It allows Partners to access their referral dashboard to track how their referrals are doing. It is Openly Operated, so user/customer privacy is ensured since all data is provably retrieved and displayed in aggregate, anonymous formats. Partner Server is not viewable to the public and has strict security groups. Partner user accounts are created by the Admin Server.

• Prerequisites
• Sign In
  • Sign In - Web
  • Sign In
  • Log Out (Delete Session)
• Partner User
  • Partner - Web
  • Change Partner User Password - Web
  • Change Partner User Password
• Other APIs
  • Test Error Logging
  • Health Check
• Support

Prerequisites

• Run the Partner CloudFormation and all its prerequisites

Sign In

The POST /signin API returns a session cookie. Use the cookie on requests that require authentication. Usually, your HTTP request framework will automatically save this cookie. If the cookie expires or server returns 401, request a new cookie.

Sign In - Web

Request

GET /signin

Sign In

Request

POST /signin

Response

Set-Cookie: <Cookie with Expiration Time>

Log Out (Delete Session)

Request

GET /logout

Response

Redirects to /signin

Partner User

Partner - Web

Request

Authentication Required

GET /partner

Change Partner User Password - Web

Request

Authentication Required

GET /change-password

Change Partner User Password

Request

Authentication Required

POST /change-password

Response

Redirect to /partner

Other APIs

Test Error Logging

Request

GET /error-test

Health Check

Request

GET /health

Response

Status 200
{
	message: "OK from Partner"
}

Feedback

If you have any questions, concerns, or other feedback, please let us know any feedback in Github issues or by e-mail.

We also have a bug bounty program -- please email [email protected] for details.

License

This project is licensed under the GPL License - see the LICENSE.md file for details

Contact

[email protected]