0% found this document useful (0 votes)
309 views

NetTrust - REST API Project Proposal PDF

This document proposes developing a REST API to interface with an existing partner API. It considers both Java and PHP implementations and outlines goals, technical approaches, timelines, and costs. The timeline estimates 2-3 months to develop the API, with another 2 months for testing and improvements. It provides implementation steps, payment schedules, maintenance costs, and service level agreements.

Uploaded by

Jonathan del Mar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
309 views

NetTrust - REST API Project Proposal PDF

This document proposes developing a REST API to interface with an existing partner API. It considers both Java and PHP implementations and outlines goals, technical approaches, timelines, and costs. The timeline estimates 2-3 months to develop the API, with another 2 months for testing and improvements. It provides implementation steps, payment schedules, maintenance costs, and service level agreements.

Uploaded by

Jonathan del Mar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 10

NetTrust : REST API Project

Project Proposal v1.0

Date: January 03, 2019


Prepared by : J​ onathan del Mar
Mobile number and Viber : +63916-791-3198
Email: [email protected]
Table of Contents

Table of Contents 1

Goals 2

Possible Technical Approach 2


Java Implementation 2
PHP Implementation 2

Timeline 3
Notes 4
Project Schedule 5

Implementation Steps 5

Payment Schedules 6

Maintenance Cost 6

SLA Summary 6

Recent Related Projects 7


Scheduler 7
Survinator 8

About the Author 9

NetTrust : REST API Project 1


Goals
● To be able to create a system which will communicate with the Partner API RESTful Web service
of ​Entrust Partner Platform​.
● To be able to setup a platform which will run the system for the Partner API RESTful Web
service.
● To be able to support the client with technical solutions for he Partner API RESTful Web service
of ​Entrust Partner Platform.

Possible Technical Approach

Java Implementation
● Server Requirements:
○ AWS EC2 with ELB (server)
○ AWS Certificate Manager (SSL)
● Software : ​Apache Tomcat
● Java Framework : Dropwizard or Spring Boot
○ Pros
■ Team to maintain the project prefers Java.
○ Cons
■ Not the simplest and quickest implementation.

PHP Implementation
● Server Requirements:
○ AWS EC2 with ELB (server)
○ AWS Certificate Manager (SSL)
● Software : ​Nginx
● PHP Framework : ​Lumen (Laravel)
○ Pros
■ Fast and small footprint.
■ Simplest and quickest implementation
○ Cons
■ Team prefers Java over other languages

NetTrust : REST API Project 2


Timeline

API Command Estimated Workdays

SSL single certificates 22-27.5 days

QuoteOrderSSL ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

ValidateOrderSSL ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

ValidateOrderSSL - Items-only validation ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

PlaceOrderSSL ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

PlaceOrderSSL - Renewal ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

RequestReissueSSL ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

ValidateReissueSSL ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

QuoteReissueSSL ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

GetDomainEmails ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

ForceFileVerification ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

CancelOrder ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

SSL Enterprise 22-27.5 days

NetTrust : REST API Project 3


GetAccountsSSLEnterprise ● Data Handling - 1-1.5 days
● Error Handling - 0.5 day
● Unit Testing - 0.5 day

GetAccountSSLEnterprise ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

QuoteOrderSSLEnterprise ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

ValidateOrderSSLEnterprise ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

PlaceOrderSSLEnterprise ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

QuoteOrderSSLEnterpriseInventory ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

QuoteOrderSSLEnterpriseInventory - Renewal ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

ValidateOrderSSLEnterpriseInventory ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

ValidateOrderSSLEnterpriseInventory - Renewal ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

PlaceOrderSSLEnterpriseInventory ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

PlaceOrderSSLEnterpriseInventory - Renewal ● Data Handling - 1-1.5 days


● Error Handling - 0.5 day
● Unit Testing - 0.5 day

Notes
● Includes TDD and Test coverage
● Includes basic QA and functional testing
● Does not include full penetration testing
● Does not include full security testing
● Does not include full QA testing

NetTrust : REST API Project 4


Project Schedule
● 1st - 3nd month - API development
● 3rd - 4th month - MVP
● 4th - 5th month - QA testing and improvements
● 5th month - Estimated deployment in production

Implementation Steps
1. Entrust Initial configuration and setup
2. System and framework setup
3. Software and command programming for each endpoint
a. Data handling
b. Error handling
c. Unit Testing
4. Server setup for staging
a. AWS setup
b. OS setup
c. Application configuration and deployment
5. Integration testing in Staging for all API endpoints
6. Server setup for Production
a. AWS setup
b. OS setup
c. Application configuration and deployment
7. Integration testing in Production for all API endpoints
8. Software Documentation
9. 30 days support/warranty
10. Maintenance if applicable

Notes:
● AWS servers costs will be shouldered by client.

NetTrust : REST API Project 5


Payment Schedules

Timeline Cost

30% Upon acceptance of terms / proposal SGD 2700

25% upon Approval of Functional Specifications SGD 2250

25% Upon Approval of Staging SGD 2250

15% Upon Approval of Production SGD 1350

5% After 30 days warranty SGD 450

TOTAL : SGD 9000

Maintenance Cost
(If Applicable)
● Monthly payment of SGD 1300 .
● Major revisions are subject to cost estimation per revision.

SLA Summary
● Severity Level Response Time
○ HIGH - within the day
○ MED - within days
○ LOW - within 5 days
● Communication Methods
○ Email
○ Telegram
○ Skype

NetTrust : REST API Project 6


Recent Related Projects

Scheduler
Technologies:
● NodeJs
● ExtJs
● AWS and Nginx
● REST API
Description :
Scheduler functions as a useful tool for agents and team lead to efficiently monitor, schedule,
and plan tasks of technicians and other employees of different companies in Belgium who are
companies subscribed to the platform. Data and view are synced automatically whenever changes are
done from another user or the main server using RESTFUL API.

NetTrust : REST API Project 7


Survinator
Technologies:
● Custom Javascript framework authored by Jonathan del Mar
● CouchDB and PouchDB NoSQL databases
● AWS and Nginx
● REST API
Description :
Scheduler functions as a tool for technicians to save data after survey in buildings and houses
which will be used to propose projects to clients. This connects to a server with a NoSQL database to
synchronise data between each technicians, team leaders, and managers using RESTFUL API.

NetTrust : REST API Project 8


About the Author

Jonathan del Mar


Software Architect, Tech Enthusiast

A highly resourceful, innovative, and competent person with more than 13 years extensive experience in
Software Engineering possessing considerable knowledge and experience in developing solutions with
enthusiasm to complete projects to the highest standard.

(Please see separate resume attached)

NetTrust : REST API Project 9

You might also like