Home

Welcome to the common-hosted-email-service wiki!

If you would like to learn about the this service and find out how to get access to use it please refer to the following:

• API Documentation: https://ches-master-9f0fbe-prod.pathfinder.gov.bc.ca/api/v1/docs/
• Showcase Application https://mssc.pathfinder.gov.bc.ca/mssc/
• Performance Dashboard: CHES Metabase Dashboard (Public)

Steps to gain Access and starting using the API:

1. Try out the Showcase app https://mssc.pathfinder.gov.bc.ca/mssc/ to see the capabilities of what you could build with access to CHES API
2. The app developer must go to getok and login https://getok-master-k8vopl-dev.pathfinder.gov.bc.ca/
   a. click create new account and tell us you app name and the idir of the person who will put the password in openshift
   b. The GETOK support team will receive your request and confirm that approval to use the NRS Common Services
3. The app developer will need to then logout and login. They should now see that they have access to manage their app's access to common services
4. follow the steps to grant access to the Common Hosted Email Service (currently this also grants access to the Common Document Generation Service
   a. Create an Openshift secret to store the service client name and password that was created
   b. test out the service client access to the api
   c. utilize the postman collection and test data to get familiar with the API usage
5. write REST calls in your application to get a token and call one or more of the CHES endpoints to send emails, send bulk mail merge, get message status, and if needed cancel pending messages, or bulk merge transactions