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.
/
Retrieve the specified no...
NP6 API Reference (8.1.0)
This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.
If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.
Languages
Servers
Production server
https://api-cm.np6.com
Bodyapplication/json
Data used to create the notifiable application
Defines the stamp informations of the notifiable application
Defines a list of providers used to deliver notifications to the application
Defines a list of exisiting notifiable application routes used to preform redirections
- Production serverhttps://api-cm.np6.com/parameters/applications
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-cm.np6.com/parameters/applications \
-H 'Content-Type: application/json' \
-H 'X-Key: string' \
-d '{
"type": "native",
"id": null,
"name": "another mobile app",
"description": "An application that handles push notifications using firebase and apns",
"active": false,
"stamp": null,
"icon": null,
"providers": [
{
"type": "firebase",
"key": "...",
"sender": "np6.push"
},
{
"type": "apns",
"certificate": {
"type": "p12",
"value": "...",
"password": "...",
"expiration": "2025-12-31T23:59:59.999Z"
},
"bundle": "com.np6.push"
}
],
"routes": [
{
"name": "home",
"value": {
"type": "literal",
"value": "app://homepage"
},
"default": true
}
],
"channels": [
{
"name": "marketing",
"value": {
"type": "literal",
"value": "marketing"
},
"default": true
}
]
}'Response
application/json
{ "type": "native", "id": "a2261c17-a896-4c57-ad1f-6a3f2d83a2cc", "name": "another mobile app", "description": "An application that handles push notifications using firebase and apns", "active": false, "stamp": { "creation": "2024-02-01T02:02:43.123Z", "modification": "2024-02-01T02:02:43.123Z" }, "icon": null, "providers": [ { "type": "firebase", "key": "...", "sender": "np6.push" }, { "type": "apns", "certificate": { "type": "p12", "value": "...", "password": "...", "expiration": "2025-12-31T23:59:59.999Z" }, "bundle": "com.np6.push" } ], "routes": [ { "name": "home", "value": { "type": "literal", "value": "app://homepage" }, "default": true } ], "channels": [ { "name": "marketing", "value": { "type": "literal", "value": "marketing" }, "default": true } ] }
- Production serverhttps://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'Response
application/json
{ "type": "native", "id": "a2261c17-a896-4c57-ad1f-6a3f2d83a2cc", "name": "another mobile app", "description": "An application that handles push notifications using firebase and apns", "active": false, "stamp": { "creation": "2024-02-01T02:02:43.123Z", "modification": "2024-02-01T07:20:11.876Z" }, "icon": null, "providers": [ { "type": "firebase", "key": "...", "sender": "np6.push" }, { "type": "apns", "certificate": { "type": "p12", "value": "...", "password": "...", "expiration": "2025-12-31T23:59:59.999Z" }, "bundle": "com.np6.push" } ], "routes": [ { "name": "home", "value": { "type": "literal", "value": "app://homepage" }, "default": true } ], "channels": [ { "name": "marketing", "value": { "type": "literal", "value": "marketing" }, "default": true } ] }
Bodyapplication/json
Data used to update the notifiable application
Defines the stamp informations of the notifiable application
Defines a list of providers used to deliver notifications to the application
Defines a list of exisiting notifiable application routes used to preform redirections
- Production serverhttps://api-cm.np6.com/parameters/applications/{uuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-cm.np6.com/parameters/applications/{uuid}?safe=true' \
-H 'Content-Type: application/json' \
-H 'X-Key: string' \
-d '{
"type": "native",
"id": "a2261c17-a896-4c57-ad1f-6a3f2d83a2cc",
"name": "another mobile app",
"description": "An application that handles push notifications using firebase and apns",
"active": false,
"stamp": null,
"icon": null,
"providers": [
{
"type": "firebase",
"key": "...",
"sender": "np6.push"
},
{
"type": "apns",
"certificate": {
"type": "p12",
"value": "...",
"password": "...",
"expiration": "2025-12-31T23:59:59.999Z"
},
"bundle": "com.np6.push"
}
],
"routes": [
{
"name": "home",
"value": {
"type": "literal",
"value": "app://homepage"
},
"default": true
}
],
"channels": [
{
"name": "marketing",
"value": {
"type": "literal",
"value": "marketing"
},
"default": true
},
{
"name": "transactional",
"value": {
"type": "literal",
"value": "transactional"
}
}
]
}'Response
application/json
{ "type": "native", "id": "a2261c17-a896-4c57-ad1f-6a3f2d83a2cc", "name": "another mobile app", "description": "An application that handles push notifications using firebase and apns", "active": false, "stamp": { "creation": "2024-02-01T02:02:43.123Z", "modification": "2024-02-01T07:20:11.876Z" }, "icon": null, "providers": [ { "type": "firebase", "key": "...", "sender": "np6.push" }, { "type": "apns", "certificate": { "type": "p12", "value": "...", "password": "...", "expiration": "2025-12-31T23:59:59.999Z" }, "bundle": "com.np6.push" } ], "routes": [ { "name": "home", "value": { "type": "literal", "value": "app://homepage" }, "default": true } ], "channels": [ { "name": "marketing", "value": { "type": "literal", "value": "marketing" }, "default": true }, { "name": "transactional", "value": { "type": "literal", "value": "transactional" } } ] }