Integration REST API

An application programming interface (API) is a set of functions and procedures for building software applications.

Press’nXPress RESTful APIs will allow you to integrate your other applications with Press’nXPress e.g. sending feedback email. Every call is validated against your organization API token. Follow the instructions below to see how to obtain the API token and make Press’nXPress API call.

Generating and Access API Token

The API token management is available in the settings menu inside organization [setting] (/docs/how-to-guides/organization-settings "Organization Settings and Configuration").

Keep the API token safe

If any of your tokens are compromised, contact support@ pxp.ai immediately to enable regeneration of the token for your integrations.

Touchpoint Token

The Touchpoint token is bound to a touchpoint, for example an email collector touchpoint. It will allow submitting requests using API on a specific touchpoint. You are required to supply the API token and Touchpoint token with every request, otherwise, the call will fail and an appropriate error message will be shown. Keep the Touchpoint token safe If any token is compromised, contact support@ pxp.ai immediately to enable regeneration of the token.

Access Touchpoint Token

To access channel token, go to specific touchpoint. For example, to access the Email touchpoint, (with admin access) find the Email touchpoint from Touchpoint menu tab. To see the token of a touchpoint, simply Click button </> under operation. A modal will open that shows the token, API URL. Note the API key needs to be added to this URL to work.

Requests

All request to Press’nXPress API must be made using secure HTTPS not HTTP.

Enqueue Email

URL

https://api.pressnxpress.com/v2/channel/mail/{channel token}/enqueue?apiKey={your api key}

Body

Following attributes are expected attributes with the request. These attributes will provide information and context about the contact and feedback requested. Note: the key names are case sensitive.

Key	Required
email	*
firstname
lastname
company
identifier

You can add additional attributes with the request to complete the context around a feedback request e.g. orderId. Note: additional attributes are case sensitive. Ensure the same format is used in all the requests. Otherwise the data will be stored and reported as a new attribute.

content-type

The content-type can be json or urlencoded.

CURL

curl -X POST \
  'http://pressnxpress.com/api/v2/channel/mail/{channel token}/enqueue?apiKey={your api key}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'email={targetEmail}' <b>curl</b>.

Responses

The response data is always returned as JSON.

Success Response

All success response follows the same schema.

{
  "message":"string"
}

Error Response

All error response follows the same schema.

{
  "message":"string"
}