Skip to content

Commit fd8b044

Browse files
committed
Update docs to markdown sintax
1 parent 4219f0c commit fd8b044

File tree

7 files changed

+46
-40
lines changed

7 files changed

+46
-40
lines changed

v0/catalog/devicelocation/devicelocation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ category:
44
uri: API Catalog
55
content:
66
excerpt: >-
7-
The Device Location Verification API from Open Gateway allows to check if a
7+
The Device Location Verification API from Open Gateway allows you to check if a
88
mobile phone is in a determined location.
99
---
1010

@@ -56,9 +56,11 @@ The standardised Device Location Verification API provides the option of verifyi
5656
This solution validates the location of a device to enable services or allow transactions by verifying the location.
5757

5858
### Fast and reliable location
59+
5960
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.
6061

61-
### Theft-free gps
62+
### Theft-free GPS
63+
6264
Location Verification is based on network data managed by telecom carriers, ensuring protection against device spoofing, GPS manipulation, or emulation.
6365

6466
### Risk prevention

v0/catalog/numberverification/numberverification.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ content:
1313
with ease.
1414
---
1515

16-
Built as part of the Open Gateway initiative, the Number Verification API provides developers universal access to essential network functionalities. Whether you're enhancing user registration processes, securing transactions, or optimizing user engagement strategies, integrating the Number Verification API enriches your application's security posture while ensuring a seamless user experience.
16+
Built as part of the Open Gateway initiative, the Number Verification API provides developers with universal access to essential network functionalities. Whether you're enhancing user registration processes, securing transactions, or optimizing user engagement strategies, integrating the Number Verification API enriches your application's security posture while ensuring a seamless user experience.
1717

1818
> 📘 Want to give it a try?
1919
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
@@ -48,20 +48,20 @@ The Number Verification CAMARA API specifies the following two operations:
4848

4949
- **GET device-phone-number:** Identifies the phone number currently associated with the user's device without requiring input, providing a straightforward way to retrieve this information.
5050

51-
***Pending for availability***
51+
***This feature is pending availability***
5252

5353
The Number Verification CAMARA API enables developers to seamlessly integrate authentication mechanisms into their applications, enhancing the user experience and security. It can also be combined with other Open Gateway APIs focused on anti-fraud measures to further bolster security.
5454

5555
Integration with channel partners and service aggregators streamlines the incorporation of telco functionalities with additional security algorithms, backup authentication methods, or external data sources. This collaboration enhances service reliability and security, leveraging APIs like Device Location Verification or SIM SWAP within the Open Gateway framework.
5656

57-
## Why Number Verification?
57+
## Why Number Verification?
5858
![NumberVerification Before](https://github.com/Telefonica/opengateway-developers-website/raw/main/v0/catalog/numberverification/images/NV(1).png)
5959

6060
In today's digital landscape, verifying phone number ownership is critical to prevent identity fraud and secure online transactions. The Number Verification CAMARA API offers a reliable solution to **authenticate users by confirming their phone numbers**. This ensures that only legitimate users gain access to digital services, bolstering security measures and building trust among customers.
6161

6262
![NumberVerification After](https://github.com/Telefonica/opengateway-developers-website/raw/main/v0/catalog/numberverification/images/NV(2).png)
6363

64-
### How does the Number Verification API help to facilitate authentication?
64+
### How does the Number Verification API help facilitate authentication?
6565

6666
The Number Verification API utilizes telco mechanisms to authenticate users seamlessly based on their device's connection to the network. This method contrasts with traditional authentication solutions by enhancing user convenience and security. Unlike manual processes or plain-text codes, network-based validation requires no user interaction, bolstering protection against unauthorized access.
6767

v0/catalog/simswap/simswap.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ category:
44
uri: API Catalog
55
content:
66
excerpt: >-
7-
The SIM Swap API from Open Gateway allows to check for SIM card swaps for
7+
The SIM Swap API from Open Gateway allows you to check for SIM card swaps for
88
fraud prevention purposes
99
---
1010

1111
The standardized SIM Swap API enables seamless integration of SIM swap detection and management functionality into your applications. This API enhances security by identifying potentially fraudulent activity and providing an additional layer of protection against unauthorized access.
1212

13-
Additionally, the SIM Swap's Unified API Access feature ensures access to network capabilities of various carriers through a single, standardized interface. This simplifies integration and improves efficiency for developers by consolidating access to multiple carrier networks.
13+
Additionally, the SIM Swap Unified API Access feature ensures access to network capabilities of various carriers through a single, standardized interface. This simplifies integration and improves efficiency for developers by consolidating access to multiple carrier networks.
1414

1515
> 📘 Want to give it a try?
1616
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
@@ -49,9 +49,9 @@ The SIM Swap CAMARA API specifies the following two operations:
4949

5050
[Check the API Reference](/reference/checksimswap)
5151

52-
## Why Sim Swap?
52+
## Why SIM Swap?
5353

54-
With the SIM Swap CAMARA API, any digital service provider can integrate the functionality of checking changes in SIM renewals directly into their software. This can be done both alone and in combination with other external inputs. Additionally, they can combine other Open Gateway APIs related to anti-fraud measures that may be of interest.
54+
With the SIM Swap CAMARA API, any digital service provider can integrate the functionality of checking changes in SIM renewals directly into their software. This can be done independently or in combination with other external inputs. Additionally, they can combine other Open Gateway APIs related to anti-fraud measures that may be of interest.
5555

5656
Aggregators play a crucial role in the anti-fraud industry. They can integrate this functionality into their software and build more sophisticated algorithms by combining other security checks, such as location verification, phone number verification, matching of contact information, external data sources, AI algorithms, etc. To achieve this, aggregators can use other Open Gateway APIs like Device Location Verification, Number Verification, or KYC-Match.
5757

v0/gettingstarted/apireference.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,34 @@ Each API has a string called “purpose” that defines the intended use of that
2121
- <u>Device Status</u>: dpv:FraudPreventionAndDetection#device-status-roaming-read
2222
- <u>QoD</u>: dpv:GeneralQAPurpose#qod
2323

24-
## Config the API Reference step by step
24+
## Configure the API Reference step by step
25+
2526
### Step 1: Get the authorization code
26-
For a faster and easier authorization it is recommended to use a [CIBA](../about/glossary.md). This CIBA is going to authorize an application to access a resource from the backend:
27-
- <u>login_hint</u>: The phone number you own and provided when creating your application. If you are using [the Sandbox](https://sandbox.opengateway.telefonica.com/my-apps), it is the number you provided when requesting access to production. If your application is a mock, you can enter any invented number that does not end with 9. The sintax is <id_type>:<id_value> (tel:+34666555432)
28-
- <u>scope</u>: The purpose+scope string for the API you want to call. You can check the scope by clicking on one of the test calls in this API reference. If not, you have a list in the *Before Getting Started* section of this page.
29-
- <u>credentials</u>: The username is your client_id and your password is you client_secret. You can get both from the info in your aplication. If you are using [a Sandbox app](https://sandbox.opengateway.telefonica.com/my-apps) you have this information in My Apps page, clicking in your app.
3027

31-
When finished, you page will look similar to the image below.
28+
For faster and easier authorization, it is recommended to use a [CIBA](../about/glossary.md). This CIBA will authorize an application to access a resource from the backend:
29+
- **login_hint**: The phone number you own and provided when creating your application. If you are using [the Sandbox](https://sandbox.opengateway.telefonica.com/my-apps), it is the number you provided when requesting access to production. If your application is a mock, you can enter any invented number that does not end with 9. The syntax is `<id_type>:<id_value>` (tel:+34666555432)
30+
- **scope**: The purpose+scope string for the API you want to call. You can check the scope by clicking on one of the test calls in this API reference. If not, you have a list in the *Before Getting Started* section of this page.
31+
- **credentials**: The username is your client_id and your password is your client_secret. You can get both from the info in your application. If you are using [a Sandbox app](https://sandbox.opengateway.telefonica.com/my-apps) you have this information in the My Apps page, by clicking on your app.
32+
33+
When finished, your page will look similar to the image below.
3234
![CIBA Auth example](https://github.com/Telefonica/opengateway-developers-website/raw/main/v0/gettingstarted/images/CIBA%20auth.png)
3335

3436
### Step 2: Get the access token
35-
For this step, go to the [*Retrieve an access token*](https://developers.opengateway.telefonica.com/reference/token) secction. Because this tutorial is using the CIBA, you must copy the authorization code in the *ACCESSTOKENCIBAREQUEST* tab:
3637

37-
- <u>grant_type</u>: Select the option *urn:openid:params:ggrant-type:ciba*
38-
- <u>auth_req_id</u>: The *auth_req_id* you get in response of the last step
38+
For this step, go to the [*Retrieve an access token*](https://developers.opengateway.telefonica.com/reference/token) section. Because this tutorial is using the CIBA, you must copy the authorization code in the *ACCESSTOKENCIBAREQUEST* tab:
3939

40-
When finished, you page will look similar to the image below.
41-
![CIBA Auth example](https://github.com/Telefonica/opengateway-developers-website/raw/main/v0/gettingstarted/images/Access%20token.png)
40+
- **grant_type**: Select the option *urn:openid:params:grant-type:ciba*
41+
- **auth_req_id**: The *auth_req_id* you got in response from the last step
42+
43+
When finished, your page will look similar to the image below.
44+
![Access Token example](https://github.com/Telefonica/opengateway-developers-website/raw/main/v0/gettingstarted/images/Access%20token.png)
4245

4346
### Step 3: Make your calls
44-
The API Reference is now prepared to make calls to the Open Gateway's APIs. Check that the credentials you made are just for one API because of the scope. Every time you change the API you are consuming, you must change the scope.
45-
The variable common to all APIs is the *access_token* you get in response of the last step, which should be placed in the authentication section.
4647

47-
![CIBA Auth example](https://github.com/Telefonica/opengateway-developers-website/raw/main/v0/gettingstarted/images/SIM%20Swap%20call.png)
48+
The API Reference is now prepared to make calls to the Open Gateway APIs. Check that the credentials you created are just for one API because of the scope. Every time you change the API you are consuming, you must change the scope.
49+
The variable common to all APIs is the *access_token* you got in response from the last step, which should be placed in the authentication section.
50+
51+
![SIM Swap Call example](https://github.com/Telefonica/opengateway-developers-website/raw/main/v0/gettingstarted/images/SIM%20Swap%20call.png)
4852

4953

5054

v0/gettingstarted/programs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ content:
88
commercial with one of our Channel Partners
99
---
1010

11-
# Open Gateway Programs
11+
# Open Gateway Programs
1212

13-
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.
13+
Once you are familiar with the Open Gateway initiative and the APIs we offer, you will want to access additional resources and start testing the APIs in your own prototype applications to perform proofs of concept on your use cases.
1414

15-
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.
15+
There are two paths you can take according to your profile and the maturity of your project, which are not exclusive if you want to go through both: either testing in the Telefónica Open Gateway Sandbox environment or shifting to the Open Gateway platform of one of our Channel Partners, closer to a commercial stage.
1616

1717
## Telefónica Open Gateway Developer Hub
1818

1919
The Open Gateway Developer Hub is your ultimate resource for prototyping and testing your use cases with ease by using our [Sandbox](/docs/sandbox), and access to exclusive content like videos or webinars. Join a thriving community of developers, get support, and explore new features with the Open Gateway Developer Hub, the essential platform for all your development needs.
2020

21-
By joining our Developer Hub you will get early access to the Open Gateway APIs, whether there are already available through any of our Channel Partners or not, as well as the latest news and updates on the Open Gateway initiative.
21+
By joining our Developer Hub you will get early access to the Open Gateway APIs, whether they are already available through any of our Channel Partners or not, as well as the latest news and updates on the Open Gateway initiative.
2222

2323
One of the main benefits of joining our Developer Hub is having access to the Telefónica Open Gateway Sandbox to actually test the APIs, but there are many other advantages from being part of our community...
2424

25-
<a href="https://opengateway.telefonica.com/en/developer-hub" target="_blank">Check the benefits of joining the Telefónica Open Gateway Developer Hub</a>
25+
[Check the benefits of joining the Telefónica Open Gateway Developer Hub](https://opengateway.telefonica.com/en/developer-hub)
2626

2727
### Telefónica Open Gateway Sandbox
2828

2929
The Open Gateway Sandbox from Telefónica is a free environment where you can test the Open Gateway APIs. It is a great way to start testing the APIs and services in a controlled environment, without the need to sign a contract or pay for the service.
3030

31-
Our Sandbox will offer you a set of APIs to test, through the same interfaces and same developer experience that our Channel Partners will provide you with. Take into account that this will help getting started faster and easier, but it is not intended for production use but for testing, learning and prototyping instead.
31+
Our Sandbox will offer you a set of APIs to test, through the same interfaces and same developer experience that our Channel Partners will provide you with. Take into account that this will help you get started faster and easier, but it is not intended for production use but for testing, learning and prototyping instead.
3232

33-
When you are ready to move to production, you will need to contact one of our Channel Partners and shift your concepts into actual applications which could need porting part of your code, specially if using our Sandbox's SDK, to the Channel Partner's toolkits and be completed with the proper environmental and operational stuff.
33+
When you are ready to move to production, you will need to contact one of our Channel Partners and shift your concepts into actual applications which could need porting part of your code, especially if using our Sandbox SDK, to the Channel Partner's toolkits and be completed with the proper environmental and operational setup.
3434

3535
[Check how to get onboarded and start using our Sandbox](/docs/usethesandbox)
3636

@@ -40,6 +40,6 @@ Whether you are a developer looking for a Channel Partner providing Open Gateway
4040

4141
The Open Gateway Partner Program is a program designed to help different players to collaborate on enhancing or enabling new use cases around Telco capabilities through the Open Gateway APIs.
4242

43-
<a href="https://opengateway.telefonica.com/en/partner-program" target="_blank">Check the benefits of joining the Telefónica Open Gateway Partner Program</a>
43+
[Check the benefits of joining the Telefónica Open Gateway Partner Program](https://opengateway.telefonica.com/en/partner-program)
4444

4545
By joining the Open Gateway Partner Program you will also have access to the Telefónica Open Gateway Sandbox.

0 commit comments

Comments
 (0)