AASHTOWare Data Integration Framework Phase 2 Session

Today's session will cover topics such as introducing the foundation, secure API design, goals, completed projects review, next session preview, and Q&A. The session emphasizes technical discussions, OpenAPI standard, and API draft walkthrough, setting the groundwork for Phase 2 efforts in data integration.

• AASHTOWare
• Data Integration
• Framework
• API Design
• Technical Discussions

barkman_l Follow

Uploaded on Feb 21, 2025 | 0 Views

Download Presentation

Please find below an Image/Link to download the presentation.

The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.

You are allowed to download the files provided on this website for personal or commercial use, subject to the condition that they are used lawfully. All files are the property of their respective owners.

The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.

Presentation Transcript

1. R e v i e w S e s s i o n AASHTOWARE DATA INTEGRATION FRAMEWORK Phase 2 Session 2 N o v e m b e r 5 t h , 2 0 2 0 A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 1

2. A G E N D A 1 2 3 4 5 6 Introduction & Session 1 Recap Organizing the Foundation Establishing a Secure API Design What is a Goal? How it all comes together Lab Exercise 2: Completed Projects, AW Project AW BrM Next Session Look-Ahead A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 7 Q&A, Close Out 2

3. Todays Session will be Recorded A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 3

4. Session 1 Recap A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 4

5. Session 1 Takeaways Sessions are conducted periodically for status reporting, collaboration, and functional show & tell The Virtual Data Lab and Portal resources were introduced The groundwork for technical discussions and insight exchanges have been set First technical introduction to the OpenAPI Standard and the authoring design suites Design Implementation Use Conclusions and deliverables from Phase 1 kickstart the Phase 2 effort API Draft 0.1 Walkthrough and Lab Exercise A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 5

6. AASHTOWare Data Lab AASHTOWare Data Lab DataLab.AASHTOWare.org A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 6

7. API Design Fundamentals: Organization A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 7

8. Conventions, Guidelines, Objectives The OpenAPI Standard provides an extensive framework that creates core conventions Within the OpenAPI Standard there are patterns/practices that help produce quality designs The desired capabilities and context establish API foundation The API Design should simple, straight-forward, and crystal clear A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 8

9. Organization Design, Implementation, and Usage each contribute influences that are ideally aligned Separation of concerns between these interests help ensure a robust result Planning for subsequent extensions/versions is a fact of life The organization of the API is critical and has a very direct impact The design must account for the expected API use as well as the logistics of implementation Uniformity is paramount A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 9

10. AW API Organization Overview A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 10

11. Distinction by Project, Module Each AW Product serves as a conceptual container for related functionality, management, or supporting resources A further segmentation then allows implementation at the most appropriate functional level The Phase 1 analysis and resulting data dictionary helps to illustrate where these natural boundaries exist. A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 11

12. Implementation Occurs by Module A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 12

13. API Security Components A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 13

14. OpenAPI Standard: Authentication | Access The OpenAPI Standard provides design support for a number of authentication methods The OpenAPI Standard supports modern enterprise practices for defining access contexts via scopes Using the authentication and access definitions, API security can be address from inception: Secure by Design This does not provide the authentication mechanisms Scope granularity is important A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 14

15. Authentication Schemes A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 15

16. Translating Scenarios to Formal API Goals A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 16

17. What is a Goal A goal is a design construct defining a capability In evaluating a functional scenario a number of simple and dependents goals can be isolated Goals are the basis of the API Design What are some examples Get account users Create profile Update profile Query available projects Update (just) the status on an activity A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 17

18. Lab Exercise 2: Phase 1 ID-101 A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 18

19. API Draft 0.2 AW Project AW Bridge A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 19

20. A Quick Flashback API Design API Implementation API Use A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 20

21. Session 3 Look-Ahead A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 21

22. Highlights Moving Data Dictionary to Schema Ontology Read Operation Goals from High Impact Scenarios AW Blaze v1.0 Authentication Sample/Example Implementation First Scopes Definition A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 22

23. Questions & Answers A A S H T O W a r e S t a n d a r d D a t a I n t e g r a t i o n F r a m e w o r k 23