Postman v2 Guide
Go to Postman v2
  • Postman v2 API Docs
    • 🤖About Postman v2
      • Postman v2 SLOs
    • Postman v2 SMS API user documentation
    • 📶Service Status
    • ⏰Postman Guide latest updates
    • 🏋️Important dates
    • 🛒Useful Links
  • Postman v2 general user guide (MoP)
    • 🔐Logging into Postman v2
    • 📢Create Campaign
      • Message Preview
      • Language tab
      • Message content
      • Character count
    • 🪵Message Logs
    • Deleting campaigns
  • Postman v2 Admin Portal, for UI Users (MOP)
    • 📤Sending messages via the Admin Portal
  • Postman v2 Admin Portal for API users (MOP)
    • ⚙️Campaign Settings
    • 🖥️Sending Messages via Postman API
  • 🪪Sending SMSes using NRIC
  • Postman v2 admin portal, for UI users (Internal)
    • Internal SMS
    • Information for new Twilio users
    • Summary of Costs
    • How do I onboard Postman v2 Internal SMS
      • 1. Sender ID Registration
      • 2. Sign up for a Twilio account
      • 3. Set up your Twilio account
      • 4. Fill your Twilio credentials on Postman
        • What if I need to buy a phone number?
      • 5. Send a Test Message
  • General notes for API users
    • 🗒️Overview
    • Authentication
    • API Errors
    • Message Delivery Errors
    • Pagination
    • Rate Limits
  • Endpoints for API users
    • 📞Endpoints for API users
    • The message object
    • Single Send
    • Single Send - Retry
    • Retrieve Message
    • Batch Send
    • Batch Send - Retry
    • Retrieve Batch
    • Retrieve Campaign Message
  • SFTP
    • 📂SFTP Integration
    • 🗝️Generating SSH Keys
    • Connecting to the SFTP server
    • Sending messages via SFTP
    • Checking whether sending via SFTP is successful
  • Load Test
    • Load Test Booking Requirement
  • FAQ
    • ❓Postman v2 FAQ
      • General Q&A
      • Sending emails to users (Legacy Postman)
      • Access related inquiries
      • Platform access related inquiries
      • User Access
      • API keys generation and IP Address whitelisting
      • Delivery Report
      • Messaging
      • Message Statuses
      • Integration and configuration related inquiries
      • Delivery rate
      • File types
      • SFTP and other integration methods
    • 💻Postman v2 API FAQ
      • API keys generation
      • Campaign related inquiries
      • API related inquiries
      • IP Address related inquiries
    • 🗃️SFTP and Other integration methods
  • Legal
    • Terms & Condition
    • Privacy Policy
  • Call App
    • Terms & Condition
    • Privacy Policy
Powered by GitBook
On this page
  • Settings - About
  • Settings - Members
  • What are some special cases?
  • Integrations
Export as PDF
  1. Postman v2 Admin Portal for API users (MOP)

Campaign Settings

How do I whitelist my IP address and obtain my API keys?

PreviousSending messages via the Admin PortalNextSending Messages via Postman API

Last updated 5 months ago

You will be able to obtain your campaign API keys and whitelist your IP address from your campaign's settings pop-up, under the integrations tab. This part will be accessible after you have and saved your campaign.

Click on your campaign and the settings icon, this will open up your settings pop-up.

Please ignore TODO: Persist sender ID under the Sender ID field.

Settings - About

You will be able to view the following details

  • Campaign ID

  • Campaign Channel

  • Campaign Message

  • Download campaign logs

Settings - Members

Learn about the three types of access rights to Postman campaigns.

Campaign Owner
Member
Member Restricted

Send messages with the campaign

Yes

Yes

Yes

Manage users and system integrations

Yes

No

No

View all messages sent

Yes

Yes

Only view messages sent by restricted member. Not able to view messages sent by other members in the campaign.

For agency officers without a .gov.sg email domain, you will need to get .gov.sg email domain from your parent ministry.

What are some special cases?

  1. Non gov.sg domains that are considered government entities

    1. For now, this is limited to aic.sg, synapxe.sg, edu.sg

    2. *By default, every user with this domains has member access rights.

    3. Otherwise, all users with these domains can already log into Postman and view campaigns they have been added to (i.e. member access)

  2. Vendors helping government entities with API integrations

    1. In such cases, Postman will not be granting vendors access to the portal. This means vendors with non-whitelisted email domains cannot log into Postman.

    2. Agency officers should log into Postman, create the campaign and craft the message, whitelist the IP addresses, generate the API keys and pass the API keys to the vendors for the necessary integration.

  3. Vendors helping government entities send messages on Postman UI

    1. Vendors will then be able to log in and send messages, but not create campaigns i.e. member access

Integrations

Integrations are where you can whitelist your IP addresses and generate your API keys.

Integrations - IP address whitelisting

Provide your IP address for whitelisting. You will be able to provide up to 20 IP addresses.

Whitelist only

  • Static IP addresses

  • IP addresses that you are using to call the Postman API.

Connect to a VPN before calling the Postman APIs.

API Keys

You will only be able to obtain your API keys after you have whitelisted your IP address.

One campaign can have up to 3 API keys.

Do API keys have an expiry?

The API keys have no expiry.

If you need to obtain a new API key, you can simply delete the old key and generate a new key.

Users with these domains who need admin access (i.e. can create campaigns, access and amend campaign settings) must request for specific email address whitelisting through the agency PIC using this

In such cases, agency PICs must for the Postman team to whitelist the vendor's domain. This will allow vendors to log into Postman, and view campaigns that the vendors have been added to by the agency admins.

⚙️
form
submit a request
created
Campaign settings - granting different access rights