GSMA's Federated Discovery Service is ending.
Wednesday 29th July 2020
The GSMA's Federated Discovery Service is being switched off on 30th September. In preparation for this, the following changes have been made to the Developer Portal:
- Discovery API documentation has been removed.
- Reference to Discovery have been removed from Mobile Connect API documentation.
- References to Discovery have been removed from the main documentation.
- Reference to Discovery have been removed from the FAQ.
- API Access requests no longer interact with API Exchange. Credentials are now provided by the Operators.
API Access Request Updates
Tuesday 12th May 2020
The API Access Screen has been updated so that:
- Application status is shown for each operator requested.
- ID Gateway Credentials are shown if available.
Mobile Connect Profile Updates
Wednesday 20th November 2019
The Developer Portal now supports updated Mobile Connect Profile (detailed below). All API documentation has been updated to support these new profiles.
General
- Generic error handling added
- The “response_mode” parameter removed from Authorize requests
- Updated Provider Metadata document
- Existing fields tidied up
Device Initiated
- New version number value added to the version parameter (
mc_di_r3.0
)
Server Initiated
- Polling Mode introduced
- New version number value added to the version parameter (
mc_si_r2.0
) - Updated Provider Metadata document
- Added support for Polling
To support these changes the API section has been re-arranged by product and can be found here. The original documents can be found in the Archived APIs section
API Documentation changes
Thursday 1st September 2019
The Device Initiated API Documentation has now been split into two separate areas (v1.1 & v2.3). This change was made it easier for developers to focus on the specific API that they will use. the two new pages can be found at the links below:
Notice of forthcoming API Exchange Update
Monday 5th August 2018
API Exchange planned update. On 13th August the APIX Exchange will be updated as follows:
Release date | 13th March 2019 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Medium | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Medium | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action |
New Apps need to make sure that any Discovery Request contains the same Redirect URL that has been registered on the Developer Portal (and, therefore, configured in APIX) for that application. Alternatively, this may be contained within the URLs provided in the Sector Identifier URI. Existing applications continue to work, but if you notice any issues please contact Mobile Connect support. NOTE: This facility will not be activated until a later date, and we will send out a notification in advance of this happening |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
Redirect URL verification The API Exchange Discovery service will now check the Redirect URL sent in the Discovery request to ensure that it is the URL that was registered when the application was promoted on the Developer Portal. Once the Redirect URL verification is enabled, the check will verify that either of the conditions below are met:
If the Redirect URL validation fails then the following error will now be returned:
New MNP service in India The new enhanced MNP service will be used for MSISDN based discovery calls in India. This is an internal update and will take effect at the time of the release. Other changes This release also contains several internal system improvements and bug fixes |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Tuesday 20th March 20187 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | None. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Tuesday 20th March 2018 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Tuesday 19th December 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | The Developer Portal now supports multiple Redirect URIs and Client Names (previously 'Application Short Name' for applications. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Tuesday 19th December 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Tuesday 14th November 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | Developers need to handle a new error for an unauthorised SP, to display a user friendly message to the end user. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
Discovery UI Support for Finnish language The Discovery UI will now support the Finnish language. The user will be able to choose the Finnish language from the language drop down. Discovery Handling SPs that are not authorised for particular MNOs Allow an operator to mark a particular SP as “not authorised”. This release makes the technical feature available for testing. The Service will not be available for use until further notice.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Monday 16th May 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Medium | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Impact | Medium | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Tuesday 19th September 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
Redirection of French Numbers For regulatory reasons French MSISDN discovery should be handled in EU (Dublin) region. If the French MSISDN discovery request reaches any other node then the request will be redirected to EU (Dublin) region. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Tuesday 11th July 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Major | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Low | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action |
In certain circumstances, for regulatory reasons, if an Indian MSISDN is received by the discovery service outside of India, it will be redirected to the Indian Local discovery instance. If the HTTP status code 302 is received, the application should follow the redirect. Service provider can provide the optional parameter (correlation_id) in discovery to uniquely identify the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
Unique Credentials Once the release is live individual MNOs will be set to “UNIQUE” which means that any new applications will have unique credentials per MNO per application. All existing credentials remain unchanged. MNOs may choose to move all apps over to “UNIQUE” credentials but that requires a detailed communication with the impacted SPs to ensure business continuity. Correlation ID An optional extra request parameter - correlation_id has been added to the discovery call. correlation_id can be used to uniquely identify and trace the call. Sample request
The discovery response is updated to include the correlation_id in the response. Sample response
The discovery error response is also updated to include correlation_id Sample response
The correlation_id, stored in the analytics server, allows retrieval of the call details using the correlation_id. UI Flows UI-Discovery redirect flow now includes the correlation_id. Pre- requisites: MSISDN POST discovery call should include correlation_id. Sample redirect
Indian numbers redirect This resolves the inconsistent behaviour of MSISDN POST and UI MSISDN flow for Indian numbers landing in Global Discovery Node (GDN). Before the change MSISDN POST returns success and UI MSISDN fails. Changes have been made to process the Indian number discovery in the Indian Local Discovery Node (LDN) even if the discovery requests lands in GDN. When the Indian number lands in GDN the request is redirected to LDN with HTTP status code 302 and ldnsessionid for both UI MSISDN and POST MSISDN flows. Once the request reaches LDN the usual flow continues. IP Discovery Performance Improvement Changes done to add the IP based response into inline memory cache to improve the IP based discovery call. IP based discovery tries to retrieve the response from in memory and tries to retrieve from database only if the cached response is not present. This is an internal code change will not have any impact. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Wednesday 10th may 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Major | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Moderate Impact. Backward Compatible | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Thursday 11th May 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
The sandbox discovery api now covers a new parameter, X-Redirect that makes it easier for native apps to handle the discovery UI. This is documented here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Wednesday 10th May 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Impact | Minor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Wednesday 26th April 2017 | ||||||||||||||||||||||||||||||||||||||||||||||||
Release type | Major | ||||||||||||||||||||||||||||||||||||||||||||||||
Developer impact | Moderate Impact. Backward Compatible | ||||||||||||||||||||||||||||||||||||||||||||||||
Expected developer action |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Release summary |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Release date | Wednesday 5th April 2017 | ||||||||||||||||||||||||||||||||||||||
Release type | Minor | ||||||||||||||||||||||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||||||||||||||||||||||
Expected developer action | None | ||||||||||||||||||||||||||||||||||||||
Release summary |
|
||||||||||||||||||||||||||||||||||||||
Release date | Wednesday 5th April 2017 | ||||||||||||||||||||||||||||
Release type | Minor | ||||||||||||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||||||||||||
Expected developer action | None | ||||||||||||||||||||||||||||
Release summary |
|
||||||||||||||||||||||||||||
Release date | Tuesday 7th March 2017 | ||||||||||||||||||
Release type | Minor | ||||||||||||||||||
Developer impact | Minor | ||||||||||||||||||
Expected developer action | None | ||||||||||||||||||
Release summary |
|
||||||||||||||||||
Release date | Tuesday 7th March 2017 | ||||||||
Release type | Minor | ||||||||
Developer impact | Minor | ||||||||
Expected developer action | None | ||||||||
Release summary |
|
||||||||
Release date | Tuesday 7th March 2017 |
Release type | Minor |
Developer impact | Minor |
Expected developer action | None |
Release summary |
These languages will now be supported in the Discovery UI.
|