From 01f5bec2601c2f9bedca81c3c0f491588f57955a Mon Sep 17 00:00:00 2001 From: mtnieto Date: Fri, 6 Sep 2024 11:07:24 +0200 Subject: [PATCH 1/5] modified postman interaction --- gettingstarted/sandbox/postmaninteraction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gettingstarted/sandbox/postmaninteraction.md b/gettingstarted/sandbox/postmaninteraction.md index 7f420ce..16e8e5b 100644 --- a/gettingstarted/sandbox/postmaninteraction.md +++ b/gettingstarted/sandbox/postmaninteraction.md @@ -51,7 +51,7 @@ To use an environment in Postmam: 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 {{variable_name}}. You simply need to edit the environment, after importing it, and modify them according to your own test configuration: - - ‘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 + - ‘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 - ‘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. - ‘application-client-secret’ - Private key to authenticate each of your registered apps. You can check it in the section ‘My apps’. - ‘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. From 39dc86f4f96ab4f46a81a35ea144f1acc29c63b7 Mon Sep 17 00:00:00 2001 From: mtnieto Date: Fri, 6 Sep 2024 11:30:09 +0200 Subject: [PATCH 2/5] updated link images and fixed typos --- callflows/apiintegration.md | 2 ++ catalog/devicelocation/devicelocation.md | 12 ++++++------ catalog/devicestatus/devicestatus.md | 4 ++-- gettingstarted/programs.md | 2 ++ gettingstarted/sandbox/postmaninteraction.md | 8 ++++---- 5 files changed, 16 insertions(+), 12 deletions(-) diff --git a/callflows/apiintegration.md b/callflows/apiintegration.md index 4177101..fbf34a0 100644 --- a/callflows/apiintegration.md +++ b/callflows/apiintegration.md @@ -4,6 +4,8 @@ excerpt: In this guide we will go through the different ways to integrate with O category: 66d57750d3f60b0011576376 --- +## RESTful by design + Since Open Gateway APIs are RESTful, you will always be able to integrate them by performing HTTP requests from any programming language providing such capability. However, most Channel Partners will provide you with SDKs in several programming languages which, by performing such requests themselves under the hood, will make your life easier when it comes to accessing the telco features that Open Gateway offers to your application. Apart from their commercial offer, check the offering of SDKs, our any other development tools, from your our Channel Partners to better suite to your use case and application needs. diff --git a/catalog/devicelocation/devicelocation.md b/catalog/devicelocation/devicelocation.md index 7609262..2d68bac 100644 --- a/catalog/devicelocation/devicelocation.md +++ b/catalog/devicelocation/devicelocation.md @@ -26,7 +26,7 @@ The Device Location Camara API specifies one operation: - **POST /verify**: answers the question ‘is the device in the circle determined by a center (latitude and longitude) and an accuracy (given in km as the radius of the circle)?’ -[Check the API Reference](/reference/retrievedevicelocation) +[Check the API Reference](/reference/verifylocation-1) ## Why device location API @@ -35,17 +35,17 @@ The standardised Device Location Verification API provides the option of verifyi This solution validates the location of a device to enable services or allow transactions by verifying the location. -### Fast and reliable location +###  Fast and reliable location The Device Location Verification API provides a swift and efficient way to validate customer locations, helping you maintain control over your application while enabling features like anti-fraud measures, personalization, and targeted advertising. -### Theft-free gps +### Theft-free gps Location verification is based on network data managed by telecom carriers, ensuring protection against device spoofing, GPS manipulation, or emulation. -### Risk prevention +### Risk prevention When combined with other APIs such as Number Verification, Device Swap, or Know Your Customer (KYC) Match, this API enhances service security, improves user experience, and reduces identity-related risks. -### Simplified integration +### Simplified integration As a standardized API, it allows seamless integration into your applications without the need for carrier-specific customizations, simplifying development and accelerating time to market. -### Footprint for your identity service +###  Footprint for your identity service The API's standardization ensures uniform access across multiple telecom providers, expanding your business reach and ensuring consistent functionality across different carriers. diff --git a/catalog/devicestatus/devicestatus.md b/catalog/devicestatus/devicestatus.md index 00bc9bd..3b4b300 100644 --- a/catalog/devicestatus/devicestatus.md +++ b/catalog/devicestatus/devicestatus.md @@ -32,11 +32,11 @@ This API provides a streamlined solution for accessing network capabilities acro Device Status allows companies to offer personalized services. Travel apps, for instance, can use the data provided by the API to offer valuable information, such as currency exchange rates or recommendations for data packages to users traveling abroad. This enhances the user experience and strengthens customer loyalty. -### Cost Reduction +### Cost Reduction The information provided by Device Status enables the implementation of cost-saving strategies, the setting of data routing rules, and the notification of customers about more affordable roaming options. This helps companies reduce international roaming fees, enhancing their offering. -### Fraud Prevention and Detection +###  Fraud Prevention and Detection By integrating this API, it's possible to generate fraud alerts to identify and mitigate suspicious activities. The API can automatically detect and respond to anomalies such as unusual changes in the location of a SIM, increasing app security and benefiting both developers and users. diff --git a/gettingstarted/programs.md b/gettingstarted/programs.md index 4fa066d..7b72501 100644 --- a/gettingstarted/programs.md +++ b/gettingstarted/programs.md @@ -4,6 +4,8 @@ excerpt: Find out how to start testing the Open Gateway APIs in our Sandbox or g category: 66d5624a492663000f4ed527 --- +# Open Gateway Programs + Once you are familiar with the Open Gateway initiative and the APIs we offer, you will want to have to access additional resources and start testing the APIs into your own prototype applications to perform proofs of concept on your use cases. There is two paths you can take according to your profile and the maturity of your project, not exclusive if you want to go through both, which are either testing in the Telefónica's Open Gateway Sandbox environment or shifting to the Open Gateway platform of one of our Channel Partners, closer to a commercial stage. diff --git a/gettingstarted/sandbox/postmaninteraction.md b/gettingstarted/sandbox/postmaninteraction.md index 16e8e5b..0583e54 100644 --- a/gettingstarted/sandbox/postmaninteraction.md +++ b/gettingstarted/sandbox/postmaninteraction.md @@ -28,11 +28,11 @@ To use a Postmam collection: 2. Service APIs / Select a specific call to view the details and configuration options. -![Available Services](https://github.com/Telefonica/opengateway-developers-website/raw/main/about/gettingstarted/sandbox/images/availableservice.png) +![Available Services](https://github.com/Telefonica/opengateway-developers-website/blob/main/gettingstarted/sandbox/images/availableservice.png) 3. You can send the request by clicking on the ‘Send’ button and view the response in the ‘Response’ tab. However, you will need to import the environment first. -![Send Request](https://github.com/Telefonica/opengateway-developers-website/raw/main/about/gettingstarted/sandbox/images/send.png) +![Send Request](https://github.com/Telefonica/opengateway-developers-website/blob/main/gettingstarted/sandbox/images/send.png) On the other hand, Postman environments allow you to have a specific configuration for each of the projects you are working on. The environment we provide you with the necessary information to carry out your tests on the Open Gateway Sandbox. @@ -42,7 +42,7 @@ To import an environment into Postman, you will need to follow the steps below: 2. Click ‘Import’ and select the environment file you wish to import. 3. Postman will import the environment and display it in the list of available environments. -![Import Environment](https://github.com/Telefonica/opengateway-developers-website/raw/main/about/gettingstarted/sandbox/images/importenvironment.png) +![Import Environment](https://github.com/Telefonica/opengateway-developers-website/blob/main/gettingstarted/sandbox/images/importenvironment.png) To use an environment in Postmam: @@ -57,6 +57,6 @@ them according to your own test configuration: - ‘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. - ‘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. -![Sandbox Environment](https://github.com/Telefonica/opengateway-developers-website/raw/main/about/gettingstarted/sandbox/images/environments.png) +![Sandbox Environment](https://github.com/Telefonica/opengateway-developers-website/blob/main/gettingstarted/sandbox/images/environments.png) For more information, you can consult the [Postman Getting Started](https://learning.postman.com/docs/getting-started/overview/) guide here. From b7e42083bf0ea9fb3fc3c3604154f13500ee4cae Mon Sep 17 00:00:00 2001 From: mtnieto Date: Fri, 6 Sep 2024 11:31:20 +0200 Subject: [PATCH 3/5] updated link to reference --- catalog/devicestatus/devicestatus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/catalog/devicestatus/devicestatus.md b/catalog/devicestatus/devicestatus.md index 3b4b300..33a788b 100644 --- a/catalog/devicestatus/devicestatus.md +++ b/catalog/devicestatus/devicestatus.md @@ -20,7 +20,7 @@ The Device Status Camara API specifies one operation: - **POST /roaming**: answers the question 'is the device in roaming?' -[Check the API Reference](/reference/devicestatus) +[Check the API Reference](/reference/getroamingstatus) ## Why Device Status? From 3a27867a4a6969845a990a5d2191210e3d59fdc6 Mon Sep 17 00:00:00 2001 From: mtnieto Date: Fri, 6 Sep 2024 11:44:07 +0200 Subject: [PATCH 4/5] changed style in postman guide --- gettingstarted/sandbox/postmaninteraction.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/gettingstarted/sandbox/postmaninteraction.md b/gettingstarted/sandbox/postmaninteraction.md index 0583e54..458b3ef 100644 --- a/gettingstarted/sandbox/postmaninteraction.md +++ b/gettingstarted/sandbox/postmaninteraction.md @@ -51,11 +51,11 @@ To use an environment in Postmam: 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 {{variable_name}}. You simply need to edit the environment, after importing it, and modify them according to your own test configuration: - - ‘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 - - ‘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. - - ‘application-client-secret’ - Private key to authenticate each of your registered apps. You can check it in the section ‘My apps’. - - ‘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. - - ‘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. + - **‘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 + - **‘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. + - **‘application-client-secret’** - Private key to authenticate each of your registered apps. You can check it in the section ‘My apps’. + - **‘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. + - **‘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. ![Sandbox Environment](https://github.com/Telefonica/opengateway-developers-website/blob/main/gettingstarted/sandbox/images/environments.png) From 55a45c76767fd651864bb744759eb20b6b5d6a4c Mon Sep 17 00:00:00 2001 From: mtnieto Date: Fri, 6 Sep 2024 11:47:06 +0200 Subject: [PATCH 5/5] added postman links --- gettingstarted/sandbox/postmaninteraction.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/gettingstarted/sandbox/postmaninteraction.md b/gettingstarted/sandbox/postmaninteraction.md index 458b3ef..86d49c7 100644 --- a/gettingstarted/sandbox/postmaninteraction.md +++ b/gettingstarted/sandbox/postmaninteraction.md @@ -6,8 +6,8 @@ category: 66d5624a492663000f4ed527 # Interact with the Open Gateway Sandbox using Postman -Here you can access the postman collection simswap_collection_postman.json and the environment with variables that you will have to configure to work with your sandbox credentials -simswap_collection_variables.json. To import a Postman collection, you will need to follow the steps below: +Here you can access the postman collection [postman_collection.json](https://github.com/Telefonica/opengateway-postman/blob/main/postman_collection.json) and the environment with variables that you will have to configure to work with your sandbox credentials +[sandbox.postman_environment.json](https://github.com/Telefonica/opengateway-postman/blob/main/sandbox.postman_environment.json). To import a Postman collection, you will need to follow the steps below: 1. Open Postman and click on the ‘Import’ button in the top left corner of the interface. 2. Select ‘File’ and browse for the collection file you wish to import into your system. @@ -17,6 +17,8 @@ Open Gateway APIs access is granted to applications, not developers, so every ap ## Hands-on Postman +### Import the Postman Collection + To use a Postmam collection: 1. Click on the imported collection in the left pane to expand it and see all its API calls. You will find them organised in folders, indicating the order in which you should make them: @@ -34,6 +36,7 @@ To use a Postmam collection: ![Send Request](https://github.com/Telefonica/opengateway-developers-website/blob/main/gettingstarted/sandbox/images/send.png) +### Import the Postman Environment On the other hand, Postman environments allow you to have a specific configuration for each of the projects you are working on. The environment we provide you with the necessary information to carry out your tests on the Open Gateway Sandbox.