# Introduction to Transparent API

## GSMA specification v3.2

The Transparent APIs are all part of the GSMA specification version 3.2.

{% hint style="warning" %}
The KPN RSP Gateway has not implemented all GSMA SGP.02 v3.2 API calls. Upon request more API calls can be implemented. Please contact [support](https://docs.kpnthings.com/kpn-things/rsp/help/support) for more information.
{% endhint %}

On the website of GSMA the complete [Remote Provisioning Architecture for Embedded UICC Technical Specification (SGP.02 v3.2)](https://www.gsma.com/newsroom/resources/sgp-02-v3-2-remote-provisioning-architecture-for-embedded-uicc-technical-specification/) has been published.

## About the Transparent APIs

We identify three types of interface for the Transparent APIs of the KPN RSP Gateway. These three types are explained in the table below.

|                               | Function call  | Callback | Notification |
| ----------------------------- | -------------- | -------- | ------------ |
| *Icon*                        | 💠             |          | 🔔           |
| *Interaction type*            | Function calls | Outbound | Outbound     |
| [*mTLS*](#mtls)               | ✅              | ✅        | ✅            |
| [*WS-Security*](#ws-security) | ✅\*            | ❌        | ❌            |

*\*) optional, but advised by KPN.*

The following diagram illustrates the type of interactions between you and the KPN RSP Gateway.

![](https://1245844536-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MHHMirZRFrp5WGM4K55%2F-MLmMnRy_Bpg7bg9y8NT%2F-MLmRfQ3mQjo8PxkQdko%2Fimage.png?alt=media\&token=a7e52827-72ed-4efb-bb4f-bda132a56ffd)

### SOAP

The Transparent APIs are all SOAP APIs. 

{% embed url="<https://www.soapui.org/learn/api/soap-vs-rest-api/>" %}

### mTLS

mTLS, short for *mutual TLS authentication*, is the **mandatory** authentication method for all incoming and outgoing connections of the Transparent API. [Learn more about mTLS](https://docs.kpnthings.com/kpn-things/rsp/transparent-api/mtls).

### WS-Security

WS-Security is an optional additional authentication method for incoming connections. We implemented the UsernameTokenProfile as prescribed by the GSMA specifications.

{% code title="Example from SGP.02\_v3.2 page 276" %}

```markup
<S11:Envelope xmlns:S11="..." xmlns:wsse="...">
  <S11:Header>
  …
  <wsse:Security>
    <wsse:UsernameToken>
      <wsse:Username>MyUsername</wsse:Username>
      <wsse:Password>MyPassword</wsse:Password>
    </wsse:UsernameToken>
    …
  </wsse:Security>
  …
```

{% endcode %}

Learn more about [UsernameTokenProfile from the official specification](http://docs.oasis-open.org/wss/v1.1/wss-v1.1-spec-os-UsernameTokenProfile.pdf).