Skip to content

Metaswitch/man-openapi

 
 

Repository files navigation

man-openapi

CC BY-SA 4.0

Welcome to the Metaswitch (a Microsoft company) fork of the APNF MAN platform API reference.

This version is forked from the APNF branch for Metaswitch use and shared under the CC-BY-SA-4.0 license. The changes made by Metaswitch are documented in the individual API files.

The OpenAPI files present in this repository provide to API clients the necessary information to access the APIs made available by the MAN platform, the STIR/Shaken french solution for service providers, and operated by the APNF (ASSOCIATION DES PLATEFORMES DE NORMALISATION DES FLUX INTER-OPERATEURS).

The APIs are split into 3 main categories:

  • Authentication API
  • GCO (Gestionnaire des Certificats Opérateurs) API
  • BPCO (Base Publique des Certificats Opérateurs) API

If you are a service provider operating in France, you need to be registered as an APNF member in order to get access to the MAN platform and be able to get STI certificates. If you are not yet a member, please contact the APNF.

Authentication API

apnf-man-platform-openapi-auth.yaml / (View in Swagger Editor)

This API reference details the method to get access tokens required for authenticating against MAN platform GCO API methods.

More information is available in the OpenAPI file itself.

GCO API

apnf-man-platform-openapi-gco.yaml / (View in Swagger Editor)

This API reference explains how to get access to all MAN platform functionalities, especially the creation and management of STI certificates to be used by service providers for signing their SIP telephone calls per the STIR SHAKEN protocol.

More information is available in the OpenAPI file itself.

BPCO API

apnf-man-platform-openapi-bpco.yaml / (View in Swagger Editor)

This API reference enumerate the public APIs to used by service provider STI-VS components to retrieve and validate STI certificates.

Licensing

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

CC BY-SA 4.0

Releases

No releases published

Packages

No packages published