Sample code for Device Status
The following samples show how to use the Open Gateway Device Status API, to control your resource management during international roaming more securely
The following code shows, for didactic purposes, a hypothetical or sample SDK, in several programming languages, from a generic Open Gateway's channel partner, also known as aggregator. The final implementation will depend on the channel partner's development tools offering. Note that channel partners' Open Gateway SDKs are just code modules wrapping authorization and API calls providing an interface in your app's programming for convenience.
Sample code on how to consume the API without an SDK, directly with HTTP requests, is also provided, and it is common and valid no matter what your partner is, thanks to the CAMARA standardization. If you do not use an SDK you need to code the HTTP calls and additional stuff like encoding your credentials, calling authorization endpoints, handling tokens, etc. You can check our sample Postman collection as a reference.
Want to give it a try before coding?
Check the API interactive reference
Table of contents
Code samples
Note
These are code samples and not finalized ready-to-run code:
- Remember to replace 'my-app-id' and 'my-app-secret' with the credentials of your app.
If you registered your test app on our Sandbox, you can retrieve its credentials here.- Remember also to replace "aggregator/opengateway-sdk" with the SDK from your aggregator.
If you are using our sandbox SDK, check info and installation of de Sandbox SDK here
Backend flow
The consumption of this API in a backend flow opens up many possibilities, from anti-fraud services such as bank transaction verification, logistics (for courier services or IoT), and even personalized campaigns by tourism operators.
The authorization protocol used in Open Gateway for backend flows is the OIDC standard CIBA (Client-Initiated Backchannel Authentication). You can check the CAMARA documentation on this flow here.
First step is to instantiate the DeviceStatus service class included in the corresponding SDK. By providing your app's credentials to the class constructor, it handles the CIBA authorization on its behalf. Providing the phone number as well, as an identifier of the line to be checked for DeviceStatus, allows authorization to be 3-legged and enables end-user consent management, and will let your app to just effectively use the API in a single line of code below.
Authorization
Since Open Gateway authorization is 3-legged, meaning it identifies the application, the operator and the operator's subscriber, who is also the end-user holder of the mobile line, each check for a different phone number needs its own SDK class instantiation, or access token if not using an SDK.
from aggregator_opengateway_sdk import ClientCredentials, DeviceStatus
credentials = ClientCredentials(
client_id='your_client_id',
client_secret='your_client_secret'
)
customer_phone_number = "+34777777777"
devicestatus_client = DeviceStatus(credentials=credentials, phone_number=customer_phone_number)
import { ClientCredentials, DeviceStatus } from "aggregator/opengateway-sdk"
const credentials: ClientCredentials(
clientId: 'my-app-id',
clientSecret: 'my-app-secret'
)
const CUSTOMER_PHONE_NUMBER = '+34777777777'
const deviceStatusClient = new DeviceStatus(credentials, undefined, CUSTOMER_PHONE_NUMBER)
import aggregator.opengatewaysdk.ClientCredentials;
import aggregator.opengatewaysdk.DeviceStatus;
ClientCredentials credentials = new ClientCredentials(
"my-app-id",
"my-app-secret"
);
final String customerPhoneNumber = "+34777777777";
DeviceStatus deviceStatusClient = new DeviceStatus(credentials, null, customerPhoneNumber);
// First step:
// Perform an authorization request
let customerPhoneNumber = "+34777777777";
let clientId = "my-app-id";
let clientSecret = "my-app-secret";
let appCredentials = btoa(`${clientId}:${clientSecret}`);
let apiScope = "dpv:FraudPreventionAndDetection#device-status-roaming-read";
const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/x-www-form-urlencoded");
myHeaders.append("Authorization", `Basic ${appCredentials}`);
const urlencoded = new URLSearchParams();
urlencoded.append("login_hint", `tel:${customerPhoneNumber}`);
urlencoded.append("scope", apiScope);
const requestOptions = {
method: "POST",
headers: myHeaders,
body: urlencoded
};
let authReqId;
fetch("https://opengateway.aggregator.com/bc-authorize", requestOptions)
.then(response => response.json())
.then(result => {
authReqId = result.auth_req_id;
})
// Second step:
// Requesting an access token with the auth_req_id included in the result above
const tokenHeaders = new Headers();
tokenHeaders.append("Content-Type", "application/x-www-form-urlencoded");
tokenHeaders.append("Authorization", `Basic ${appCredentials}`);
const tokenParams = new URLSearchParams();
tokenParams.append("grant_type", "urn:openid:params:grant-type:ciba");
tokenParams.append("auth_req_id", authReqId);
const tokenRequestOptions = {
method: "POST",
headers: tokenHeaders,
body: tokenParams
};
let accessToken;
fetch("https://opengateway.aggregator.com/token", tokenRequestOptions)
.then(response => response.json())
.then(result => {
accessToken = result.access_token;
})
// First step:
// Perform an authorization request
String customerPhoneNumber = "+34777777777";
String clientId = "my-app-id";
String clientSecret = "my-app-secret";
String appCredentials = clientId + ":" + clientSecret;
String credentials = Base64.getEncoder().encodeToString(appCredentials.getBytes(StandardCharsets.UTF_8));
String apiScope = "dpv:FraudPreventionAndDetection#device-status-roaming-read";
HttpClient client = HttpClient.newHttpClient();
Map<Object, Object> data = new HashMap<>();
data.put("login_hint", "tel:" + customerPhoneNumber);
data.put("scope", apiScope);
StringBuilder requestBody = new StringBuilder();
for (Map.Entry<Object, Object> entry : data.entrySet()) {
if (requestBody.length() > 0) {
requestBody.append("&");
}
requestBody.append(URLEncoder.encode(entry.getKey().toString(), StandardCharsets.UTF_8));
requestBody.append("=");
requestBody.append(URLEncoder.encode(entry.getValue().toString(), StandardCharsets.UTF_8));
}
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://opengateway.aggregator.com/bc-authorize"))
.header("Content-Type", "application/x-www-form-urlencoded")
.header("Authorization", "Basic " + credentials)
.POST(BodyPublishers.ofString(requestBody.toString()))
.build();
HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
JSONObject jsonResponse = new JSONObject(response.body());
String authReqId = jsonResponse.getString("auth_req_id");
// Second step:
// Requesting an access token with the auth_req_id included in the result above
Map<Object, Object> data = new HashMap<>();
data.put("grant_type", "urn:openid:params:grant-type:ciba");
data.put("auth_req_id", authReqId);
StringBuilder requestBody = new StringBuilder();
for (Map.Entry<Object, Object> entry : data.entrySet()) {
if (requestBody.length() > 0) {
requestBody.append("&");
}
requestBody.append(URLEncoder.encode(entry.getKey().toString(), StandardCharsets.UTF_8));
requestBody.append("=");
requestBody.append(URLEncoder.encode(entry.getValue().toString(), StandardCharsets.UTF_8));
}
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://opengateway.aggregator.com/token"))
.header("Content-Type", "application/x-www-form-urlencoded")
.header("Authorization", "Basic " + credentials)
.POST(BodyPublishers.ofString(requestBody.toString()))
.build();
HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
JSONObject jsonResponse = new JSONObject(response.body());
String accessToken = jsonResponse.getString("access_token");
import base64
import requests
# First step:
# Perform an authorization request
customer_phone_number = "+34777777777"
client_id = "my-app-id"
client_secret = "my-app-secret"
app_credentials = f"{client_id}:{client_secret}"
credentials = base64.b64encode(app_credentials.encode('utf-8')).decode('utf-8')
api_scope = "dpv:FraudPreventionAndDetection#device-status-roaming-read"
headers = {
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": f"Basic {credentials}"
}
data = {
"login_hint": f"tel:{customer_phone_number}",
"scope": api_scope
}
response = requests.post(
"https://opengateway.aggregator.com/bc-authorize",
headers=headers,
data=data
)
auth_req_id = response.json().get("auth_req_id")
# Second step:
# Requesting an access token with the auth_req_id included in the result above
headers = {
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": f"Basic {credentials}"
}
data = {
"grant_type": "urn:openid:params:grant-type:ciba",
"auth_req_id": auth_req_id
}
response = requests.post(
"https://opengateway.aggregator.com/token",
headers=headers,
data=data
)
access_token = response.json().get("access_token")
API usage
result = devicestatus_client.roaming(customer_phone_number) # as set in the authorization step
print(f"Is device in roaming status? {result}")
let result = deviceStatusClient.roaming(undefined, customer_phone_number, undefined, undefined, undefinend)
print (`Is the device in roaming status? ${result}`)
CompletableFuture<Boolean> resultFuture = deviceStatusClient.roaming();
resultFuture.thenAccept(result -> {
System.out.println("Is the device in roaming status? " + result);
```
})
const apiHeaders = new Headers();
apiHeaders.append("Content-Type", "application/json");
apiHeaders.append("Authorization", `Bearer ${accessToken}`);
const apiRequestBody = JSON.stringify({
"phoneNumber": customerPhoneNumber // as set in the authorization step
});
const apiRequestOptions = {
method: "POST",
headers: apiHeaders,
body: apiRequestBody
};
fetch("https://opengateway.aggregator.com/device-status/v0/roaming", apiRequestOptions)
.then(response => response.json())
.then(result => {
console.log(`Roaming? ${result.roaming} \nCountry: ${result.countryName[0]} (${result.countryCode})`);
})
JSONObject requestBody = new JSONObject();
requestBody.put("phoneNumber", customerPhoneNumber); // as set in the authorization step
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://opengateway.aggregator.com/device-status/v0/roaming"))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer " + accessToken)
.POST(BodyPublishers.ofString(requestBody.toString()))
.build();
HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
JSONObject jsonResponse = new JSONObject(response.body());
String roaming = jsonResponse.getString("roaming");
String countryName = jsonResponse.getJSONArray("countryName").getString(0);
String countryCode = jsonResponse.getString("countryCode");
System.out.println("Roaming? " + roaming +
"\nCountry: " + countryName +
" (" + countryCode + ")");
headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {access_token}"
}
data = {
"ueId": {"msisdn": customer_phone_number}, # as set in the authorization step
}
response = requests.post(
"https://opengateway.aggregator.com/device-status/v0/roaming",
headers=headers,
json=data
)
result = response.json()
print(f"Roaming? {result.get('roaming')} \n Country: {result.get('countryName')[0]} ({result.get('countryCode')})")
Frontend flow
While some use cases of the Device Status API do not involve the user’s device in the API usage flow, others can utilize the API to check roaming status directly from the frontend. For example, a mobile application could use it as an additional authentication factor or to adjust its content based on the user’s country.
If you wanted to start the service API consumption from a frontend application, you would need to implement the OIDC's Authorization Code Flow instead of CIBA. This flow implies your application providing a callback URL that you will need to publish online hosted on your backend server, and in which your application's backend will get a code authorizing it to use the Open Gateway APIs for your end-user.
This flow allows the mobile network operator to effectively identify the user by resolving the IP address of their device, running your application, by getting an HTTP redirection and returning a code that will reach out to your callback URL. You can check the CAMARA documentation on the Authorization Code Flow here.
From this point, your application, from its backend, will request an access token, and use it to call the service API.
Authorization
Some Channel Partners may provide you with frontend SDKs to handle the Authorization Code Flow on your application's behalf, providing some extra features like checking your end-user's device network interface to avoid problems caused from it being connected to a WiFi network, for instance, since this flow relies on the mobile line connectivity for the operator to identify the end-user and authorize your application.
The following samples show how to implement the flow without a frontend SDK with these premises:
- Application's frontend performs an HTTP request to get a
code, and provides aredirect_uriit wants suchcodeto be redirected to. - Application's frontend will receive an HTTP redirect (status 302) and needs to be able to handle it. If it is a web application running on a web browser, the browser will natively follow the redirection. If it is not, in depends on the coding language and/or HTTP module or library used, or on its settings, how the flow will follow all the way to your application's backend through the mobile network operator authorization server.
- Application's backend receives the
codefrom this HTTP redirection, by publishing an endpoint in the givenredirect_uri, and then exchanges it for an access token. The latter can be achieved by using a backend SDK as shown in the Backend flow.
The authorization protocol used in Open Gateway for frontend flows is the OIDC standard Authorization Code Flow. You can check the CAMARA documentation on this flow here.
Requesting the authorization code from the frontend
The following samples show how your application can trigger the authorization flow from the frontend either from code or by submitting a simple HTML form. The same can be achieved from code in any other programming language with the ability to perform HTTP requests:
let userPhoneNumber = "+34777777777";
let clientId = "my-app-id";
let clientSecret = "my-app-secret";
let apiScope = "dpv:FraudPreventionAndDetection#device-status-roaming-read";
let myCallbackEndpoint = "https://my_app_server/device-status-callback";
let deviceStatusParams = {
phone_number: userPhoneNumber
}
const params = {
client_id: clientId,
response_type: "code",
scope: apiScope,
redirect_uri: myCallbackEndpoint,
login_hint: `tel:${userPhoneNumber}`,
state: encodeURIComponent(JSON.stringify(deviceStatusParams)) // Using `state` as the parameter that is always forwarded to the redirect_uri
};
// Create the query string
const queryString = new URLSearchParams(params).toString();
// URL with query string
const url = `https://opengateway.aggregator.com/authorize?${queryString}`;
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch(url, requestOptions);
<!--
In this example you need your callback URL to continue the flow calling the service API
and providing an HTML response to be shown in the web browser displaying the result.
The following form is published from the same web server hosting the callback URL.
-->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API Request Form</title>
<script>
function submitForm() {
var phoneInput = document.getElementById('phone_number').value;
var deviceStatusParams = {
phone_number: phoneInput
};
document.getElementById('login_hint').value = 'tel:' + phoneInput;
document.getElementById('state').value = encodeURIComponent(JSON.stringify(deviceStatusParams));
document.getElementById('apiRequestForm').submit();
}
</script>
</head>
<body>
<h1>Verify Device Status</h1>
<form id="apiRequestForm" action="https://opengateway.aggregator.com/authorize" method="GET">
<input type="hidden" name="client_id" value="my-app-id">
<input type="hidden" name="response_type" value="code">
<input type="hidden" name="scope" value="dpv:FraudPreventionAndDetection#device-status-roaming-read">
<input type="hidden" name="redirect_uri" value="https://my_app_server/device-status-callback">
<input type="hidden" id="login_hint" name="login_hint" value="">
<input type="hidden" id="state" name="state" value="">
<label for="phone_number">Your phone number:</label>
<input type="text" id="phone_number" name="phone_number" value="+34777777777" required>
<button type="button" onclick="submitForm()">Verify Device Status</button>
</form>
</body>
</html>
Getting the access token from the callback endpoint at the backend
Samples represent how to publish the callback URL in Python or Node.js, so the code from the Auth Code Flow can be received. The same can be achieved in any other language with capabilities to run an HTTP server and listen for the redirect from the authorization flow:
import sandboxSdk from '@telefonica/opengateway-sandbox-sdk'
const { DeviceStatus } = sandboxSdk
import express from "express"
const credentials = {
clientId: 'your_client_id',
clientSecret: 'your_client_secret'
}
const app = express()
const port = 3000
app.get('/device-status-callback', (req, res) => {
const code = req.query.code
const state = req.query.state
const deviceStatusClient = new DeviceStatus(credentials, code)
})
app.listen(port, () => {
console.log(`Device Status callback URL is running`)
})
import json
from flask import Flask, request
from aggregator_opengateway_sdk import ClientCredentials, DeviceStatus
credentials = ClientCredentials(
clientid='my-app-id',
clientsecret='my-app-secret'
)
app = Flask(__name__)
@app.route('/device-status-callback', methods=['GET'])
def callback():
code = request.args.get('code', '')
state = request.args.get('state', '')
devicestatus_client = DeviceStatus(credentials=credentials, code=code)
if __name__ == '__main__':
app.run()
import { ClientCredentials, DeviceStatus } from "aggregator/opengateway-sdk"
import express from "express"
const credentials: ClientCredentials(
clientId: 'my-app-id',
clientSecret: 'my-app-secret'
)
const app = express()
const port = 3000
app.get('/device-status-callback', (req, res) => {
const code = req.query.code
const state = req.query.state
const deviceStatusClient = new DeviceStatus(credentials, code)
})
app.listen(port, () => {
console.log(`Device Status callback URL is running`)
})
import base64
import json
import requests
from flask import Flask, request
client_id = "my-app-id"
client_secret = "my-app-secret"
app_credentials = f"{client_id}:{client_secret}"
credentials = base64.b64encode(app_credentials.encode('utf-8')).decode('utf-8')
app = Flask(__name__)
@app.route('/device-status-callback', methods=['GET'])
def callback():
code = request.args.get('code', '')
state = request.args.get('state', '')
headers = {
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": f"Basic {credentials}"
}
data = {
"grant_type": "authorization_code",
"code": code
}
response = requests.post(
"https://opengateway.aggregator.com/token",
headers=headers,
data=data
)
access_token = response.json().get("access_token")
if __name__ == '__main__':
app.run()
import express from "express"
let clientId = "my-app-id"
let clientSecret = "my-app-secret"
let appCredentials = btoa(`${clientId}:${clientSecret}`)
const app = express()
const port = 3000
app.get('/device-status-callback', (req, res) => {
const code = req.query.code
const state = req.query.state
let accessToken
const myHeaders = new Headers()
myHeaders.append("Content-Type", "application/x-www-form-urlencode")
myHeaders.append("Authorization", `Basic ${appCredentials}`)
const requestBody = JSON.stringify({
"grant_type": "authorization_code",
"code": code
})
const requestOptions = {
method: "POST",
headers: myHeaders,
body: requestBody
}
fetch("https://opengateway.aggregator.com/token", requestOptions)
.then(response => response.json())
.then(result => {
accessToken = result.access_token
})
})
app.listen(port, () => {
console.log(`Device Status callback URL is running`);
})
API usage
Once your app is authenticated it only takes a single line of code to use the service API and effectively get a result.
data = json.loads(state)
result = await devicestatus_client.verify(data['latitude'], data['longitude'], data['accuracy'], data['phone_number'])
print(f"Is device in roaming status? {result.roaming}")
const data = JSON.parse(state)
let result = deviceStatusClient.roaming(undefined, data.phoneNumber, undefined, undefined, undefined)
console.log(`Is device in roaming status? ${result.roaming}`)
const data = JSON.parse(state)
let result = deviceStatusClient.roaming(data.phoneNumber)
console.log(`Is device in roaming status? ${result.roaming}`)
data = json.loads(state)
phone_number = data['phone_number']
headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {access_token}"
}
payload = {
"ueId": {"msisdn": phone_number}
}
response = requests.post(
"https://opengateway.aggregator.com/device-status/v0/roaming",
headers=headers,
json=payload
)
result = response.json()
print(f"Roaming? {result.get('roaming')} \n Country: {result.get('countryName')[0]} ({result.get('countryCode')})")
const data = JSON.parse(state);
const phone_number = data.phone_number;
const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", `Bearer ${accessToken}`);
const requestBody = JSON.stringify({
"ueId": { "msisdn": phone_number }
})
const requestOptions = {
method: "POST",
headers: myHeaders,
body: requestBody
}
fetch("https://opengateway.aggregator.com/device-status/v0/roaming", requestOptions)
.then(response => response.json())
.then(result => {
console.log(`Roaming? ${result.roaming} \nCountry: ${result.countryName[0]} (${result.countryCode})`);
})
Updated about 2 months ago