The Notifications Service API provides access to the Notification Server through an HTTP REST interface. The Notifications REST API is platform and programming-language independent; therefore, your service can be developed using your preferred environment and tools.
The Notifications REST API supports the following methods for sending the notifications:
Sending a notification to a single user, using the unique Notification ID provided by the MIDlet (client).
You must make sure that your MIDlet shares the Notification ID with your service. ID sharing takes place outside of the notification service connection.
There are things that you need to take into account when developing your service and switching between the environments — Developing and testing in the sandbox and running your published service in production and/or Chinese production environment(s). There are some values that you need to modify to run your service successfully in each of the environments. The following table presents what is service specific and what is not; what you need to take into account when you are developing your service and switch between the different service environments — sandbox, production, and Chinese production.
|
Term |
Environment specific |
Pay attention to this |
|---|---|---|
|
Application ID |
No |
An Application ID remains the same regardless of the environment. |
|
Developer Console sending tool |
Yes |
The Nokia Developer Console sending tool can be used to send notifications to MIDlets in the sandbox environment, and cURL in the production or the Chinese production environments. |
|
NID, Notification ID |
Yes |
The sandbox and the production environments make use of the common base of the Notification IDs. The Chinese production environment uses different Notification IDs. The developer needs to design the notifications service such that it stores the Notification IDs correctly and distinguishes the Notification IDs between the environments. This is to ensure that when sending a notification to a device in a selected environment, the Notification ID belongs to the target environment. |
|
Notification Enabler (client end) |
Yes |
The Notification Enabler can be configured to point to any one of the three Nokia Notification Server environments at a time. The developer needs to use the Environment Selector application on the device to set the Notification Enabler to point to the required environment. The user's device automatically gets configured to use the appropriate environment as per the following rules:
|
|
Sandbox server address |
Yes |
The notifications service needs to connect to the address alpha.one.ovi.com to be able to send notifications to the Notification Enabler and the connected MIDlet when using the sandbox environment. The Nokia Developer Console sending tool can also be used to send notifications to the Notification Enabler and the connected MIDlet when the Environment Selector application on the device is used to set the Notification Enabler to point to the sandbox environment. The notifications service and the Notification Enabler should use the same environment for notifications to work. The developer should ensure the Environment Selector application on the device is used to set the Notification Enabler to point to the correct environment. |
|
Production server address |
Yes |
The notifications service needs to connect to the address nnapi.ovi.com to be able to send notifications to the Notification Enabler and the connected MIDlet when using the production environment. The notifications service and the Notification Enabler should use the same environment for notifications to work. The developer should ensure the Environment Selector application on the device is used to set the Notification Enabler to point to the correct environment. |
|
Chinese production server address |
Yes |
The notifications service needs to connect to the address nnapi.ovi.com.cn to be able to send notifications to the Notification Enabler and the connected MIDlet when using the Chinese production environment. The notifications service and the Notification Enabler should use the same environment for notifications to work. The developer should ensure the Environment Selector application on the device is used to set the Notification Enabler to point to the correct environment. |
|
Service ID |
No |
The service ID value is common for all the environments. |
|
Service Secret |
Yes |
A service has as separate Service Secret for all of its active service environments. |
Every service has a base amount of messages that it can send over one hour. If the quota is exceed, you will get an error 503. The service may check the status of the sent messages quota using theQuery limitations request.
The Notification Server stores up to 5 latest undelivered notifications for each user's MIDlet. The maximum expiration time for a notification is 1209600 seconds, which is 14 days.