Skip to content

Commit

Permalink
Merge pull request #52 from Telefonica/mt/apireference
Browse files Browse the repository at this point in the history
Mt/apireference
  • Loading branch information
mtnieto authored Dec 2, 2024
2 parents 2e30da1 + bdb36e8 commit f41a5e2
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 33 deletions.
64 changes: 33 additions & 31 deletions callflows/authorization/authorization_openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,46 @@ servers:
default: sandbox.opengateway.telefonica.com/apigateway
description: API gateway URL
paths:
/bc-authorize:
post:
summary: CIBA
tags:
- Authorize an application
security:
- basicAuth: []
description: |
Authorizes an application to access a resource from the backend
Check the [Backend authorization flow guide](/docs/backend) for more information.
operationId: bcAuthorize
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/AuthorizeRequest"
required: true
responses:
"200":
description: Returns an authorization code
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationRequestId"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
/authorize:
get:
summary: Auth Code Flow
tags:
- Authorize an application
security:
- {}
x-readme:
explorer-enabled: false
description: |
Authorizes an application to access a resource from the user device
Expand Down Expand Up @@ -85,37 +118,6 @@ paths:
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
/bc-authorize:
post:
summary: CIBA
tags:
- Authorize an application
security:
- basicAuth: []
description: |
Authorizes an application to access a resource from the backend
Check the [Backend authorization flow guide](/docs/backend) for more information.
operationId: bcAuthorize
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/AuthorizeRequest"
required: true
responses:
"200":
description: Returns an authorization code
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationRequestId"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
/token:
post:
summary: /token
Expand Down
4 changes: 2 additions & 2 deletions gettingstarted/sandbox/usethesandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ For every application you create, you will need to follow these simple steps to

![Production mode and mock mode of Sandbox](https://github.com/Telefonica/opengateway-developers-website/raw/main/gettingstarted/sandbox/images/production_mock.png)

- **Mock mode**
- **Mock mode**

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.

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.

![Usage mode](https://github.com/Telefonica/opengateway-developers-website/raw/main/gettingstarted/sandbox/images/usage-mode.png?raw=true)

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.
1. 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.

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.

Expand Down

0 comments on commit f41a5e2

Please sign in to comment.