8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
Development
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
The provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here. This section also provides guidance on how candidate products are tested and how GovStack validates a product's API against the API specifications defined here.
The tests for the Information Mediator Building Block can be found in .
The majority of functions provided by the Information Mediator Building Block are either defined in the “service access flow” or configured by the administrator via the web User Interface. There is, however, a “Directory Service” which can provide listings of clients, methods, and available API specifications for services on the Information Mediator. The directory is managed by admins of members. The directory service centralizes and offers knowledge of all enrolled members and their services along with the information necessary to bind a third-party application as a consumer of that service. These services are described here:
and changes to the API definitions can be made by submitting a pull request on this repository. Additional APIs may be implemented by the Building Block, but the listed APIs define a minimal set of functionality that should be provided by any implementation of this Building Block.
The services can be accessed via the following Service APIs:
The full API definition of all available services is the set of all available OpenAPI descriptions.
One can take any of the available OpenAPI descriptions and call service according to that description.
This call must be forwarded to IM local Security Server and path part of the called URL must begin with the address of service in the form /r1/{instanceId}/{memberClass}/{member}/{application}/{service}/ followed by the service path with possible query parameters. The address of the service may be already listed in the OpenAPI description or must be added to the path if not provided by OpenAPI.
At development time, to see which organizations are available on GovStack, an administrator of application A sends a GET request to the security server: url-of-local-information-mediator-security-server/r1/listClients
The response is an array of organizations with descriptions. API MAY implement paging of output.
At development time, an administrator at application A sends a GET request to the security server: url-of-local-information-mediator-security-server/r1/INDIA/GOV/MEMBER/APPLICATION/{listMethods || allowedMethods}
The response is an array of services (either all services or services that the requester is authorized to access via “allowedMethods”). API MAY implement paging of output.
At development time, to learn about an available service, an administrator at application A sends a GET request to the security server: url-of-local-information-mediator-security-server/r1/INDIA/GOV/MEMBER/APPLICATION/getOpenApi?serviceCode=SERVICE
The response is an OpenAPI specification, detailing the endpoints and requirements for that service/API of the requested Service of Application.
To broadcast a message to a Room, the service access API must be followed and the service requested must be the service implementing event type.
To get info from system log, an administrator may send a request to the logging API.
At the debugging time, to learn about system performance or retrieve an audit log, an administrator may send a request to the reporting API.
The response is <audit trail>, <metrics>, etc.
Clients of the security server have the capability to obtain a list
of potential service providers within a GovStack instance, including
both members and applications.
To do so, they should initiate an HTTP GET request to the security
server.
The specific request URL will be either http://SECURITYSERVER/listClients
or https://SECURITYSERVER/listClients, depending on whether HTTPS
protocol usage is enabled for interaction.
When submitting this request, the placeholder SECURITYSERVER must be
replased with the actual address of the security server. One can also
retrieve a list of clients from other federated GovStack instances
by adding an additional HTTP parameter:
instanceId - a code of the instance.
For instance, if you wish to fetch the list of clients associated with the
instance labeled as ABC, your request URL should take the form of
http://SECURITYSERVER/listClients?instanceId=ABC.
This function provides a list of all REST services and service endpoints offered by a service provider.
This function provides a list of REST services and service endpoints offered by a service provider that the caller has permission to invoke.
This metaservice is designed to retrieve service descriptions for
REST services.
It provides the OpenAPI service description for a specific REST service.
To use this service, the query parameters should include serviceCode=xxx,
where xxx corresponds to the service code of the particular REST service
for which you desire to obtain the service description.
Filter by member class
Filter by member code
Filter by application ID
Filter by service ID
Number of access rights returned on one page
100Handle for the next page, if the result spans multiple pages. If not specified, there are no more results.
Return list of my subscriptions in the room {applicationCode}
Return details of subscription to {eventType} in the room {applicationCode}
Return next unacknowledged event of type defined by {eventType} and located in the room {applicationCode}
event type
Acknowledge receiving of event from the room {applicationCode}
event id
No content
Return event status info. Event is located in the room {applicationCode}
event id of event
Stop processing of the event. Event is located in the room {applicationId}
event id of event
No content
Return list of event types located in the room {applicationCode}
Return event type description. Event type is located in the room {applicationCode}
Create new instance of IM
Creates Central Servers if init=true
falseSubdomain for GovStack instance to run in
sample.sandbox.govstack.globalName of GovStack instance
nowherelandList of Member organisations
Update IM configuration. Not described parts are not changed
Subdomain for GovStack instance to run in
sample.sandbox.govstack.globalName of GovStack instance
nowherelandList of Member organisations
Replace IM configuration. Not described parts are deleted
Subdomain for GovStack instance to run in
sample.sandbox.govstack.globalName of GovStack instance
nowherelandList of Member organisations
Kind of organisation. Namespace for organisation {code}
GOVRegistration number (or identifier) of the organisation in {memberClass} namespace
7001Name of application
CitizensRegistryName of service/API
registrationApplications that are allowed or denied access
No content
Kind of organisation. Namespace for organisation {code}
GOVRegistration number (or identifier) of the organisation in {memberClass} namespace
7001Name of application
CitizensRegistryName of service/API
registrationApplications that are allowed or denied access
No content
Subscribe caller to {eventType} in the room {applicationCode}
newBirthPUSHAvailable options: No content
Update details of subscription to {eventType} in the room {applicationCode}
newBirthPUSHAvailable options: No content
Publish event in the room {applicationCode}
newBirth{"dateTime":"2023-05-01T11:25:00+02:00","gender":"M","mother":"Jane Doe","place":"City Hospital","details":{"weight":3200,"length":49,"eyesColor":"brown"}}Create new event type in the room {applicationCode}
newBirth{ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "dateTime": { "type": "string", "format": "date-time" }, "gender": { "type": "string", "enum": ["M", "F"] }, "mother": { "type": "string" }, "place": { "type": "string" }, "id": { "type": "integer" }, "details": { "type": "object", "properties": { "weight": { "type": "number" }, "length": { "type": "number" }, "eyesColor": { "type": "string" } }, "required": ["weight", "length", "eyesColor"] } }, "required": ["dateTime", "gender", "mother", "place"] }No content