Scribd
Upload
8 views

[Datavision] API Building Steps_v2

The document outlines the build process for IRSI APIs in Transact, detailing six key phases: Requirements Gathering, Specification & Design, Build, Deployment, UAT Testing, and Go-Live Deployment. Each phase includes necessary documents, deliverables, and responsible parties, ensuring a structured approach to API development. Additionally, it highlights the implementation of DevOps practices and various tools for source control, performance monitoring, and project management.

Uploaded by

Kamal T
Copyright
© © All Rights Reserved
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
8 views

[Datavision] API Building Steps_v2

The document outlines the build process for IRSI APIs in Transact, detailing six key phases: Requirements Gathering, Specification & Design, Build, Deployment, UAT Testing, and Go-Live Deployment. Each phase includes necessary documents, deliverables, and responsible parties, ensuring a structured approach to API development. Additionally, it highlights the implementation of DevOps practices and various tools for source control, performance monitoring, and project management.

Uploaded by

Kamal T
Copyright
© © All Rights Reserved
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
You are on page 1/ 9

IRIS API building process in

Transact

10 Feb 2025

1
Build process of IRSI APIs in Transact

1 Requirements
Gathering 2 Specification &
Design

6 Go-live deployment
3 Build

5 UAT testing
4 Deployment

2
Build process of IRSI APIs in Transaction

1 Requirement Gathering

Documents & Input


 Business Requirement Document (BRD) / Functional Requirement Specification
(FRS)
 API Consumer Use Cases with functionality and Origin
 Inputs will be discussed during Stakeholder Meetings & Workshops
 Setup Status Update meetings

Deliverables
 Clear objectives documented in BRD with well-defined API list and functionality,
scope, data and use cases.
 Estimate and timeline

Responsible
 FINABANK
 FDA

3
Build process of IRSI APIs in Transact

2 Specification & Design

Documents & Inputs


 Signed off BRD with clear objectives and APIs
 Technical Feasibility Assessment and Design Recommendations
 Appropriate Environment and relevant Tools availability.

Deliverables
 API Technical Specification Documentation taking in consideration different
aspects : optimization, performance, compliance, security and including
Swager, data model and mapping.
 API Endpoint Definition (URLs, HTTP Methods)
 Authentication & Authorization Strategy
 Error Handling Strategy

Responsible
 DATAVISION
 FINABANK

4
Build process of IRSI APIs in Transact

3 Build

Documents & Inputs


 Signed off Technical Specification Document
 Development Frameworks & Best Practices
 Code Standards & Secure Coding Guidelines

Deliverables
 API Source Code
 T24 Artifacts newly created / updated
 Install Guide
 API Documentation (Swagger file, Postman Collection, Unit Tests Report, Sample
Requests / Responses)

Responsible
 DATAVISION

5
Build process of IRSI APIs in Transact

4 Deployment

Documents & Inputs


 Delivery package with all the API components
 Comprehensive deployment documents with clear instructions
 Support from DATAVISION

Deliverables
 Target environment properly impacted, and the API is ready to use
 API Sanity check is successfully performed

Responsible
 FINABANK

6
Build process of IRSI APIs in Transact

5 UAT Testing

Documents & Inputs


 Test Plan & Scenarios
 Test Data (realistic business cases and sample transactions)
 Deployed API in UAT Environment
 API Documentation (Swagger, Postman Collection)
 Issue Tracking System (bugzilla / Jira)
 Support from DATAVISION for Testing & Issue Resolution

Deliverables
 Signed-off UAT Test Results
 List of Issues & Bugs (if any) with Severity Classification
 Approval for Go-Live Deployment

Responsible
 FINABANK
 FDA

7
Build process of IRSI APIs in Transact

6 Go-Live Deployment

Documents & Inputs


 Deployment Checklist (ensuring all pre-go-live tasks are completed)
 Final System Validation Report
 Confirmed Client Readiness (including trained users and infrastructure checks)
 Final Version of API Documentation
 Deployment Package (including the latest build and environment
configurations)

Deliverables
 API successfully deployed in production
 Post-golive support from DATAVISION

Responsible
 FINABANK

8
Build process of IRSI APIs in Transact

Additional Features

 Source control management tools, e.g. GitLab, Bitbucket


 Implement DevOps (CI/ CD) Practices
 CI Tools, e.g. Jenkins/ GitLab, Maven
 SAST (Static Application Security Testing), e.g. SonarQube, Checkmarx
 Repositories, e.g. Sona type Nexus, Jfrog Artifactory
 CD Tools, e.g. Jenkins, Ansible
 Performance monitoring tools, e.g. DynaTrace, AppDynamics, Splunk
 Project management, User Stories, Documentation & Bugs tracking tools, e.g.
JIRA/ Bugzilla, Confluence

You might also like