You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| device > **networkAccessIdentifier** / **phoneNumber** / **ipv4Address** / **ipv6Address** ends in **9**| 409 | code: "CONFLICT"<br>message: "Another session is created for the same UE" |
33
+
| device > **networkAccessIdentifier** / **phoneNumber** / **ipv4Address** / **ipv6Address** ends in **9**| 409 | code: "CONFLICT"<br/>message: "Another session is created for the same UE" |
34
34
|**duration** Not in range **1...86400** seconds | 400 | message: error on duration not in range |
|**device** > **networkAccessIdentifier** / **phoneNumber** / **ipv4Address** / **ipv6Address** ends in **4**| 404 | message: Device not found |
59
59
|**maxAge** included and > 14400 | 404 | message: Device not found in the given maxAge |
60
-
|**maxAge** not included<br>**center** > **latitude** round to integer ends in **0**| 200 | verificationResult: **"UNKNOWN"**|
61
-
|**maxAge** included<br>**center** > **latitude** round to integer ends in **0**| 200 | verificationResult: **"UNKNOWN"**<br>lastLocationTime: (30 minutes + maxAge) to now |
62
-
|**center** > **latitude** round to integer ends in **1**| 200 | verificationResult: **"PARTIAL"**<br>lastLocationTime: (30 minutes + maxAge) to now<br>matchRate: something between 50 if radius=2 and 99 if radius=200 |
60
+
|**maxAge** not included<br/>**center** > **latitude** round to integer ends in **0**| 200 | verificationResult: **"UNKNOWN"**|
61
+
|**maxAge** included<br/>**center** > **latitude** round to integer ends in **0**| 200 | verificationResult: **"UNKNOWN"**<br/>lastLocationTime: (30 minutes + maxAge) to now |
62
+
|**center** > **latitude** round to integer ends in **1**| 200 | verificationResult: **"PARTIAL"**<br/>lastLocationTime: (30 minutes + maxAge) to now<br/>matchRate: something between 50 if radius=2 and 99 if radius=200 |
63
63
|**center** > **latitude** round to integer is **even**| 200 | verificationResult: **"TRUE"**|
64
64
|**center** > **latitude** round to integer is **odd**| 200 | verificationResult: **"FALSE"**|
| Any invalid input | 400 | message: Details on the invalid input value |
79
-
| Valid input | 200 | For every input value, response includes...<br>match: boolean<br>matchScore: 0...100 (only for some keys)<br>Those will be the result of matching the request data with a [mock user persona](https://github.com/camaraproject/KnowYourCustomer/blob/a2575b08550640999614a43dd2146ceab6b6e469/code/API_definitions/kyc-match.yaml#L105)|
79
+
| Valid input | 200 | For every input value, response includes...<br/>match: boolean<br/>matchScore: 0...100 (only for some keys)<br/>Those will be the result of matching the request data with a [mock user persona](https://github.com/camaraproject/KnowYourCustomer/blob/a2575b08550640999614a43dd2146ceab6b6e469/code/API_definitions/kyc-match.yaml#L105)|
80
80
81
81
### KYC Age Verification (v0.1)
82
82
@@ -105,4 +105,4 @@ It will determine which mock user persona is used to verify the line holding ten
Copy file name to clipboardExpand all lines: v0/gettingstarted/sandbox/postmaninteraction.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Test the Sandbox with Postman
3
3
category:
4
-
uri: Getting Started
4
+
uri: Getti - **'device-local-ip'** - Local IPv4 of a device on the home WiFi network for calls to the home network APIs (e.g. Home Devices QoD). If this is more convenient for you. You can modify the calls in the collection to specify this value in them instead of using the `{{device-local-ip}}` variable. - **'mobile-phone-number'** - Mobile line number for mobile network API calls (e.g. SIM Swap). If it is more convenient for you. You can modify the calls in the collection to indicate this value in them instead of using the `{{mobile-phone-number}}` variable.g Started
5
5
content:
6
6
excerpt: >-
7
7
Learn how to explore the functionality of the Sandbox environment using
@@ -56,7 +56,7 @@ To use an environment in Postmam:
56
56
57
57
1. Select the desired environment by clicking on the drop-down menu in the top right corner of the interface.
58
58
2. The variables defined in the environment will be available for use in collection requests. Collection requests already use the following environment variables in the format
59
-
{{variable_name}}. You simply need to edit the environment, after importing it, and modify
59
+
`{{variable_name}}`. You simply need to edit the environment, after importing it, and modify
60
60
them according to your own test configuration:
61
61
-**‘api-gateway-url** - Fixed. Should not be changed if you want to run your tests on the Sandbox. Its value is https://sandbox.opengateway.telefonica.com/apigateway
62
62
-**‘application-client-id’** - Value that identifies each of the apps you have registered in the Sandbox. You can check it in the ‘My apps’ section.
[](https://www.youtube.com/watch?v=uo94M3QGkjw)
25
14
26
15
## Usage modes
27
16
28
17
-**Production mode**
29
18
30
-
Although our Sandbox is not a Channel Partner's production environment but a testing environment instead, it can route your API calls to our mobile operators to provide a real response if you test your prototype application from a device connected to one of their networks. That requires that you are the mobile line holder and have the SIM card installed in such device.
19
+
Although our Sandbox is not a Channel Partner's production environment but a testing environment instead, it can route your API calls to our mobile operators to provide a real response if you test your prototype application from a device connected to one of their networks. This requires that you are the mobile line holder and have the SIM card installed in such device.
31
20
32
21
Movistar (Spain) and O2 (Germany) are already available for testing from the Telefónica Open Gateway Sandbox, and other Telefónica operators in other countries will be added soon.
33
22
34
-
The production mode is disabled by default for Privacy reasons, but you can enable it by filling in your legal information and accepting the terms and conditions in the form that the Sandbox console will offer you for that purpose. You will have to provide some mobile phone numbers of your own which will be added to a whitelist that will allow you to test the APIs in production mode from your own devices and will block API usage accessing someone else's personal data.
23
+
The production mode is disabled by default for privacy reasons, but you can enable it by filling in your legal information and accepting the terms and conditions in the form that the Sandbox console will offer you for that purpose. You will have to provide some mobile phone numbers of your own which will be added to a whitelist that will allow you to test the APIs in production mode from your own devices and will block API usage accessing someone else's personal data.
35
24
36
25
37
26
-**Mock mode**
38
27
39
28
You can test your application without the need to have a SIM card from one of our mobile operators. The Sandbox will provide you with a mock response for every API call you make.
40
29
41
-
The mock mode will also make available for you some APIs that are not still commercially available on our mobile operators, so you can test them in advance.
30
+
The mock mode will also make available to you some APIs that are not yet commercially available on our mobile operators, so you can test them in advance.
42
31
43
32
Check the [Sandbox mock responses](/docs/sandbox/mocks) guide for more information on how to use the mock mode and the mock responses you can expect.
44
33
@@ -50,7 +39,7 @@ Open Gateway APIs access is granted to applications, not developers, so every ap
50
39
51
40
[More information on Privacy](/docs/privacy)
52
41
53
-
Therefore the way to get credentials to test the APIs is to register an application in the Sandbox console. You will use your application credentials to authenticate your requests to the APIs from any test you code no matter if it is actually a comprehensive application or just a tiny script to run from the a command line interface.
42
+
Therefore the way to get credentials to test the APIs is to register an application in the Sandbox console. You will use your application credentials to authenticate your requests to the APIs from any test you code, no matter if it is actually a comprehensive application or just a tiny script to run from a command line interface.
54
43
55
44
> 📘 How to access the Open Gateway Sandbox
56
45
> To use the Sandbox, you must [join the Developer Hub](https://opengateway.telefonica.com/en/developer-hub) and enter in your [private area](https://opengateway.telefonica.com/en/profile/technical-toolbox/sandbox)
@@ -69,22 +58,22 @@ According to the usage modes described [above](#usage-modes)
69
58
70
59
3. Briefly describe your application as part of the application onboarding process so that mobile operators can understand the purpose of your tests and validate it
71
60
72
-
Since it is a testing environment, your application won't be rejected as per this information, but our Sandbox uses standard procedures to register applications in the mobile operators' systems which takes this data as mandatory.
61
+
Since it is a testing environment, your application won't be rejected based on this information, but our Sandbox uses standard procedures to register applications in the mobile operators' systems which takes this data as mandatory.
73
62
74
63
These are the fields you need to fill in:
75
64
76
65
- **Name**: A name to identify your application by the operators as an Open Gateway APIs consumer.
77
-
- **Full name**: Your application's commercial name by which operators can find it in your website or application stores.
66
+
- **Full name**: Your application's commercial name by which operators can find it on your website or application stores.
78
67
- **Description**: A brief description of your application's use case related to the usage of the APIs.
79
-
- **Redirect URL**: (Optional) For frontend triggered authorization flows, you must indicate an URI hosted on your servers for the flow to call back to your code for it to complete authorization and perform the service API request (check [frontend triggered authorization flow](/docs/frontend) for detailed information).
68
+
- **Redirect URL**: (Optional) For frontend triggered authorization flows, you must indicate a URI hosted on your servers for the flow to call back to your code for it to complete authorization and perform the service API request (check [frontend triggered authorization flow](/docs/frontend) for detailed information).
4. Check the specifications and accept the terms and conditions per API and operator
84
73
85
74
Each mobile operator has its own terms and conditions for the usage of each API, and its own technical specifications you will want to consider when it comes to consuming them, so you will need to accept them for each API you want to test on each operator you have previously selected.
86
75
87
-
Since our Sandbox is just a free testing environment, specifications are not binding and conditions are meant for safeguarding privacy, even given that only whitelisted phone numbers can be used when testing in the Production mode with our mobile operators. In the case of the Mock mode, a global simulated operator will provide you with mock responses being the terms and conditions of the program you are member to that applies.
76
+
Since our Sandbox is just a free testing environment, specifications are not binding and conditions are meant for safeguarding privacy, even given that only whitelisted phone numbers can be used when testing in the production mode with our mobile operators. In the case of the mock mode, a global simulated operator will provide you with mock responses, and the terms and conditions of the program you are a member of will apply.
88
77
89
78
90
79
@@ -103,21 +92,21 @@ To get your application credentials and use them in your prototype, go to the ap
Note that if you selected the Production mode, you will have to wait for the approval of your application by the mobile operators you selected. When your application status is "Completed" you are good to test the APIs with your applications's credentials no matter what end-user phone number you are using. If you only selected the Mock mode, you can start testing right away.
95
+
Note that if you selected the production mode, you will have to wait for the approval of your application by the mobile operators you selected. When your application status is "Completed" you are ready to test the APIs with your application's credentials, no matter what end-user phone number you are using. If you only selected the mock mode, you can start testing right away.
107
96
108
97
## Using the APIs
109
98
110
99
So far you have used the Sandbox console to register your application as the client to the APIs, which means your application is the entity granted access with its credentials.
111
100
112
-
> You can use this credentials directly in the [API reference](/reference)
101
+
> You can use these credentials directly in the [API reference](/reference)
113
102
114
-
Now you will use such credentials to effectively consume de APIs from your code. You can use any programming language and any platform that supports HTTP requests, or you can use the Sandbox SDK for convenience. Our Open Gateway Sandbox provides you with a Python SDK and will publish SDKs in other common languages soon.
103
+
Now you will use such credentials to effectively consume the APIs from your code. You can use any programming language and any platform that supports HTTP requests, or you can use the Sandbox SDK for convenience. Our Open Gateway Sandbox provides you with a Python SDK and will publish SDKs in other common languages soon.
115
104
116
105
[Check the pros and cons of using HTTP integration or SDKs to consume the APIs](./sdkreference)
117
106
118
107
When it comes to our Sandbox's SDK, the following particular considerations apply:
119
108
- Once you shift to a Channel Partner in a commercial stage, your production code will need to use their SDKs instead of the Sandbox's one you used for testing and prototyping or, in the worst case, you will have to use the HTTP integration method instead if no SDK is available for your app's language.
120
-
- Our Sandbox does not provide a fronted SDK, so if the use case you are prototyping triggers the authorization flow from the end-user device, you will need to implement it by coding HTTP integration. Once you progress to a production stage, you need to check your Channel Partner toolkit offering.
109
+
- Our Sandbox does not provide a frontend SDK, so if the use case you are prototyping triggers the authorization flow from the end-user device, you will need to implement it by coding HTTP integration. Once you progress to a production stage, you need to check your Channel Partner toolkit offering.
121
110
122
111
If you want to integrate the APIs from your code using HTTP requests, you will need to follow the [API integration guide](/docs/apiintegration) to understand the authorization flows and the API reference to know the endpoints and parameters you need to use.
0 commit comments