# Quicksilver-API
API gateway to Quicksilver (Message Broker) functionality.

## Endpoints

#### Users

| Endpoint               | Functionality                                                              | Message                                                                                            |
| ---------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `POST /user/register`  | [User registration](documentation/endpoints/user.md#user-registration)     | [user.registration.transactional](documentation/messages/user.registration.transactional.md)       |
| `POST /user/password`  | [User password reset](documentation/endpoints/user.md#user-password-reset) | [user.password_reset.transactional](documentation/messages/user.password_reset.transactional.md)   |


#### Campaigns

| Endpoint                    | Functionality                                                                    | Message                                                                                       |
| --------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `POST /campaign/signup`     | [Campaign signup](documentation/endpoints/campaign.md#campaign-signup)           | [campaign.signup.transactional](documentation/messages/campaign.signup.transactional.md)      |
| `POST /campaign/reportback` | [Campaign report back](documentation/endpoints/campaign.md#campaign-report-back) | [campaign.report_back.transactional](documentation/messages/campaign.signup.transactional.md) |

#### Tests
- [Mocha](https://www.npmjs.com/package/mocha)
- [Should](https://www.npmjs.com/package/should)
- [Supertest](https://www.npmjs.com/package/supertest)

```
$ npm test
```
# Quicksilver-API
API gateway to Quicksilver (Message Broker) functionality.

## Endpoints

#### Users

| Endpoint               | Functionality                                                              | Message                                                                                            |
| ---------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `POST /user/register`  | [User registration](documentation/endpoints/user.md#user-registration)     | [user.registration.transactional](documentation/messages/user.registration.transactional.md)       |
| `POST /user/password`  | [User password reset](documentation/endpoints/user.md#user-password-reset) | [user.password_reset.transactional](documentation/messages/user.password_reset.transactional.md)   |


#### Campaigns

| Endpoint                    | Functionality                                                                    | Message                                                                                       |
| --------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `POST /campaign/signup`     | [Campaign signup](documentation/endpoints/campaign.md#campaign-signup)           | [campaign.signup.transactional](documentation/messages/campaign.signup.transactional.md)      |
| `POST /campaign/reportback` | [Campaign report back](documentation/endpoints/campaign.md#campaign-report-back) | [campaign.report_back.transactional](documentation/messages/campaign.signup.transactional.md) |

## Tests
- [Mocha](https://www.npmjs.com/package/mocha)
- [Should](https://www.npmjs.com/package/should)
- [Supertest](https://www.npmjs.com/package/supertest)

```
$ npm test
```
Adjust Test heading to second level
Adjust Test heading to second level
