This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.
A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.
Production server https://api-cm.np6.com/parameters/applications
curl
JavaScript
Node.js
Python
Java
C#
PHP
Go
Ruby
R
Payload
curl -i -X GET \ https://api-cm.np6.com/parameters/applications \ -H 'X-Key: string'
Responses
A list of notifiable applications
Bodyapplication/jsonArray [
typestring
Discriminator
idstring(uuid)
Defines the unique id of the notifiable application
namestring
Defines the name of the notifiable application
descriptionstring
Defines the description of the notifiable application
activeboolean
Defines the online state of the application
stampobject
Defines the stamp informations of the notifiable application
creationstring(date-time)
Defines a date, used to store the creation date of a related data
modificationstring(date-time)
Defines a date, used to store the last modification date of a related data
iconstring
Defines the base64 value of the notifiable application icon
providersArray of objects
Defines a list of providers used to deliver notifications to the application
typestring
Discriminator
keystring
Defines the "firebase" api key used to send notifications
senderstring
Defines the "firebase" sender id used to send notifications
routesArray of objects
Defines a list of exisiting notifiable application routes used to preform redirections
namestring
Defines the name of the route
valueobject
Defines the value of the route
defaultboolean
Defines this route as the default route
channelsArray of objects
Defines a list of exisiting notifiable application channels used to handle display behaviors
A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.
Bodyapplication/json
Data used to create the notifiable application
typestring
Discriminator
idstring(uuid)
Defines the unique id of the notifiable application
namestring
Defines the name of the notifiable application
descriptionstring
Defines the description of the notifiable application
activeboolean
Defines the online state of the application
stampobject
Defines the stamp informations of the notifiable application
creationstring(date-time)
Defines a date, used to store the creation date of a related data
modificationstring(date-time)
Defines a date, used to store the last modification date of a related data
iconstring
Defines the base64 value of the notifiable application icon
providersArray of objects
Defines a list of providers used to deliver notifications to the application
typestring
Discriminator
keystring
Defines the "firebase" api key used to send notifications
senderstring
Defines the "firebase" sender id used to send notifications
routesArray of objects
Defines a list of exisiting notifiable application routes used to preform redirections
namestring
Defines the name of the route
valueobject
Defines the value of the route
defaultboolean
Defines this route as the default route
channelsArray of objects
Defines a list of exisiting notifiable application channels used to handle display behaviors
namestring
Defines the name of the channel
valueobject
Defines the value of the channel
defaultboolean
Defines this route as the default route
Production server https://api-cm.np6.com/parameters/applications
A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.
Production server https://api-cm.np6.com/parameters/applications/{uuid}
curl
JavaScript
Node.js
Python
Java
C#
PHP
Go
Ruby
R
Payload
curl -i -X GET \ 'https://api-cm.np6.com/parameters/applications/{uuid}' \ -H 'X-Key: string'
Responses
A notifiable application
Bodyapplication/json
typestring
Discriminator
idstring(uuid)
Defines the unique id of the notifiable application
namestring
Defines the name of the notifiable application
descriptionstring
Defines the description of the notifiable application
activeboolean
Defines the online state of the application
stampobject
Defines the stamp informations of the notifiable application
creationstring(date-time)
Defines a date, used to store the creation date of a related data
modificationstring(date-time)
Defines a date, used to store the last modification date of a related data
iconstring
Defines the base64 value of the notifiable application icon
providersArray of objects
Defines a list of providers used to deliver notifications to the application
typestring
Discriminator
keystring
Defines the "firebase" api key used to send notifications
senderstring
Defines the "firebase" sender id used to send notifications
routesArray of objects
Defines a list of exisiting notifiable application routes used to preform redirections
namestring
Defines the name of the route
valueobject
Defines the value of the route
defaultboolean
Defines this route as the default route
channelsArray of objects
Defines a list of exisiting notifiable application channels used to handle display behaviors