Postman Setup

ENP Postman Collection

You can find the postman collection here

Environment Setup

There are currently only two environment variables required by the ENP endpoints:

• enp-admin-secret - for pre-request script to generate auth
• notification-id - for testing connection to notification api db

If you have existing environments from Notification API you must simply add the variable enp-admin-secret to your Postman environment(s). It uses the value from the ssm parameter /dev/va-enp-api/admin_secret_key, so you'll also need to grab that value from AWS.

Otherwise, you can create a new environment with the above listed variables. Remember to populate enp-admin-secret with the value from the SSM parameter /dev/va-enp-api/admin_secret_key.

Service API key authentication

Note: currently supported for v2/legacy SMS route

You will need a valid service and service API key secret in notification-api DB.

1. Verified service

GET {{notification-api-url}}/service/{{service-id}}

2. Created API key for service, saving the secret

POST {{notification-api-url}}/service/{{service-id}}/api-key

3. Verified API key

{{notification-api-url}}/service/{{service-id}}/api-keys

Your Postman environment should have the following values for service authentication

1. service-id to identify the service the API key was issued for
2. service-api-key for the secret obtained from creating a service API key
3. enp-use-service-auth set to TRUE or true to use the service authentication, default is to use original admin authentication