|Oracle® Communications Services Gatekeeper OneAPI Application Developer's Guide
Part Number E24006-01
This chapter presents an overview of Oracle Communications Services Gatekeeper OneAPI server functionality and the ways that application developers can use this functionality to interact with Services Gatekeeper.
This document provides an overview of the basic concepts you need to know in order to create applications that successfully interact with Services Gatekeeper using the OneAPI specifications published for Global System for Mobile Communications (GSM) operators.
OneAPI application request data flows through Services Gatekeeper through communication services. A communication service consists of a service type (such as Multimedia Messaging and Terminal Location and so on), an application-facing interface (also called a “north” interface), and a network-facing interface (also called a “south” interface).
OneAPI operations are processed by the same south interfaces to network components used by the proprietary Services Gatekeeper RESTful facade for supported services.
For more information on communication services, see Communication Service Guide.
The Services Gatekeeper OneAPI interface complies with Open Mobile Alliance (OMA) specifications. For more information on OMA, see:
Services Gatekeeper supports the following OneAPI services:
There are a number of communication services for which OneAPI does not provide a standard interface. Services Gatekeeper supports these services using the proprietary RESTful interface. A complete list of supported services is available in RESTful Application Developer's Guide.
The GSMA provides application developers OneAPI specifications for using these services when interacting with a OneAPI server. Services Gatekeeper, acting as a OneAPI server, provides response messages to operations as specified by the OneAPI specification.
Applications use the OneAPI RESTful Short Messaging interface to send and receive SMS messages, to fetch SMSs and delivery status reports, and to start and stop a notification.
When the request body for an SMS operation contains a request for a delivery receipt, the application provides a correlator for the message being sent and includes an endpoint address for returning the delivery notification.
For a complete description of the OneAPI RESTful SMS interface, including example operations, see Chapter 3, "OneAPI Short Messaging."
Applications use the OneAPI RESTful Multimedia Messaging interface to send a multimedia message (MMS) and to fetch information on MMSs that have been received for the applications and stored by Services Gatekeeper.
Applications use the interface to fetch those messages, get delivery status on sent messages, and start and stop a notification.
For a complete description of the OneAPI RESTful MMS interface, including example operations, see Chapter 4, "OneAPI Multimedia Messaging."
Applications use the OneAPI RESTful Location interface to get a location for an individual terminal or a group of terminals.
For a complete description of the OneAPI RESTful Location interface, including example operations, see Chapter 5, "OneAPI Terminal Location."
Applications use the OneAPI RESTful Payment interface to charge an amount to an end-user's account, refund amounts to that account, query charge amount status and list charge amount transactions. Applications can also reserve amounts, reserve additional amounts, charge against the reservation and release the reservation.
For a complete description of the OneAPI RESTful Location interface, including example operations, see Chapter 6, "OneAPI Payment."
You can develop applications and test them using the Application Test Environment (ATE).
This tool hosts a set of virtual communication services that correspond to many of the communication services provided by Services Gatekeeper. For example, you can test tasks such as opening sessions, sending and receiving messages, and examining delivery reports through a set of virtual communication services without having to connect to the network operator´s Services Gatekeeper installation.
For more information on using the Application Test Environment, see SDK User's Guide.