JSON API

From YateBTS
Revision as of 15:17, 13 July 2015 by Gratiela.dumitrica (Talk | contribs) (Created page with "YateHSS/HLR offers a JSON API for configuration. Use the API to configure the SS7 setting of the server and for managing subscribers. The JSON API is accessed via the managem...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

YateHSS/HLR offers a JSON API for configuration. Use the API to configure the SS7 setting of the server and for managing subscribers.

The JSON API is accessed via the management IP address associated to each server. This IP address is provisioned by the MMI (Mobile Management Interface) or set by hand.

Request format

To use it, make a HTTPS POST request with “Content-Type” header “application/json” and “Mobile-API-Secret” header set to a preconfigured value.

Path for requests: https://ip_management/mobile/api.php

Requests have the following format:

{ request: request_name, params: {..} }

Response format

The API always returns a JSON object with the “Content-Type” set to “application/json”.

In case of success:

{ error: 0 } 
{ error: 0, object_name: [ {}, {} ] } // array of objects of the specific type. Ex: subscriber, pdn 

In case of an error:

{ error: !0, message: ... }

Turn to the next pages, JSON API for Configuration and JSON API for Subscriber Management to find out more about the supported requests and their parameters.