diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index 3b7237b..2432626 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -2,20 +2,20 @@ Checklist for location-verification v1.0.0 in r1.2 -| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | -|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M |Y| [/code/API_definitions/location-verification.yaml](/code/API_definitions/location-verification.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M |Y| | -| 3 | Guidelines from ICM applied | O | M | M | M |Y| | -| 4 | API versioning convention applied | M | M | M | M |Y| | -| 5 | API documentation | M | M | M | M |Y| inline in yaml | -| 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/location-verification-User-Story.md](/documentation/API_documentation/location-verification-User-Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M |Y| [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M |Y| [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | -| 9 | Test result statement | O | O | O | M |N| Fall24 EXCEPTION: Test results not available (*) | -| 10 | API release numbering convention applied | M | M | M | M |Y| | -| 11 | Change log updated | M | M | M | M |Y| [/CHANGELOG.md](/CHANGELOG.md) | -| 12 | Previous public release was certified | O | O | O | M |Y| | +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | +|----|----------------------------------------------|:-----:|:-----------------:|:-----------------:|:-----------------:|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------:| +| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/location-verification.yaml](/code/API_definitions/location-verification.yaml) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | | +| 4 | API versioning convention applied | M | M | M | M | Y | | +| 5 | API documentation | M | M | M | M | Y | inline in yaml | +| 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/location-verification-User-Story.md](/documentation/API_documentation/location-verification-User-Story.md) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | +| 9 | Test result statement | O | O | O | M | N | Test results not available (*) | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | Y | | (*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release. diff --git a/documentation/API_documentation/location-verification-User-Story.md b/documentation/API_documentation/location-verification-User-Story.md index 4242963..e785cf8 100644 --- a/documentation/API_documentation/location-verification-User-Story.md +++ b/documentation/API_documentation/location-verification-User-Story.md @@ -1,11 +1,11 @@ # Location Verification API User Story -| **Item** | **Details** | -| ---- | ------- | -| ***Summary*** | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. | -| ***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
**Scope:**
- Verifies if the specified device is located within a predefined geographical area (e.g.circle with given coordinates and radius, polygon...). | -| ***Pre-conditions*** |The preconditions are listed below:
  1. The ASP:BusinessManager and ASP:Administrator have been onboarded to the CSP's API platform.
  2. The ASP:BusinessManager has successfully subscribed to the Location Verification API product from the product catalog via (or not) a Channel Partner.
  3. The ASP:Administrator has onboarded the ASP:User to the platform.
  4. The ASP:User performs an authorization request to CSP
  5. The CSP checks access & End-User approval then provide access token to the ASP:User
  6. The ASP:User get the access token, via (or not) the Channel Partner, allowing a secure access of the API. -| ***Activities/Steps*** | **Starts when:** The ASP:User makes a POST request via the Location Verification API providing the End-User's device identifier (e.g., phone number), the area information (center coordinates and radius, polygon...) and the maximum age of the location information.
    **Ends when:** The CSP's Location Verification server responds with the verification result indicating if the End-User's device is within the specified area, partially matches the area, or is unknown. | -| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the End-User's device location. | -| ***Exceptions*** | Several exceptions might occur during the Location Verification API operations
    - Unauthorized: Invalid credentials (e.g., expired access token).
    - Incorrect input data (e.g., malformed phone number).
    - Not able to provide: Network unable to locate the device due to various reasons (e.g., device not connected, outdated location data). | +| **Item** | **Details** | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ***Summary*** | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. | +| ***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
    **Scope:**
    - Verifies if the specified device is located within a predefined geographical area (e.g.circle with given coordinates and radius, polygon...). | +| ***Pre-conditions*** | The preconditions are listed below:
    1. The ASP:BusinessManager and ASP:Administrator have been onboarded to the CSP's API platform.
    2. The ASP:BusinessManager has successfully subscribed to the Location Verification API product from the product catalog via (or not) a Channel Partner.
    3. The ASP:Administrator has onboarded the ASP:User to the platform.
    4. The ASP:User performs an authorization request to CSP
    5. The CSP checks access & End-User approval then provide access token to the ASP:User
    6. The ASP:User get the access token, via (or not) the Channel Partner, allowing a secure access of the API. | +| ***Activities/Steps*** | **Starts when:** The ASP:User makes a POST request via the Location Verification API providing the End-User's device identifier (e.g., phone number), the area information (center coordinates and radius, polygon...) and the maximum age of the location information.
      **Ends when:** The CSP's Location Verification server responds with the verification result indicating if the End-User's device is within the specified area, partially matches the area, or is unknown. When the device partially matches the area, the server additionally responds with a match-rate, which defines a percent value of the intersection of both areas. | +| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the End-User's device location. | +| ***Exceptions*** | Several exceptions might occur during the Location Verification API operations
      - Unauthorized: Invalid credentials (e.g., expired access token).
      - Incorrect input data (e.g., malformed phone number).
      - Not able to provide: Network unable to locate the device due to various reasons (e.g., device not connected, outdated location data). |