Unit 37- Assignment V3 (1)
Unit 37- Assignment V3 (1)
Submission Format
The submission should be an API application and a single e-report which includes code
snippets (with comments) and diagrams where appropriate. The report should be typeset in
Times New Roman with font size 12 and line spacing 1.5, and headings should be consistent
in style. References must be clearly cited in-text and provided in a list of references at the
end of the report using the APA7 referencing style. Ensure the submission is free from
spelling and grammar errors by using the tools available with word processing applications.
Unit Learning Outcomes
LO1. Examine what an API is, the need for APIs and types of APIs
LO2. Apply the knowledge of API research to design an application that incorporates
relevant APIs for a given scenario or a substantial student chosen application
LO3. Implement an application in a suitable development environment
LO4. Document the testing of the application, review and reflect on the APIs used.
Vocational scenario
Code Techniques Pvt Ltd, a renowned software development company, has recently secured a
project to design and develop a sophisticated web application for a high-profile client. As a
software engineer at Code Techniques, you've been assigned the crucial responsibility of
developing the backend part of the application, leveraging your expertise in API design and
development.
The client's requirements are diverse and demanding. They need a robust web application that
seamlessly integrates with various third-party services, handles a large volume of data, and ensures
top-notch security standards. The frontend team is tasked with creating an intuitive user interface,
while your focus lies in architecting a scalable, efficient, and reliable backend system. You are
fully responsible for developing the application for the substantial chosen application. You have
to develop this e-commerce application with both the backend and frontend, following the
guidelines provided below provided by your tech lead.
To design the backend API for the system, you need to examine APIs, the relationship between
an API and a software development kit (SDK), the need for APIs, and the types of APIs required
for your system. The API must encompass components related to authentication and authorization,
requiring an evaluation of potential security issues surrounding them.
Furthermore, you should discuss with the team to identify additional requirements beyond CRUD
operations, such as a payment portal API, report generation API, or API for Google Analytics.
Applying knowledge from API research, design an application that incorporates relevant APIs for
specific scenarios, and assess a range of APIs suitable for the platform, covering various uses.
The initial task involves creating a design document for a substantial application that will utilize
a range of APIs, providing justifications for the chosen ones. Clearly outline the requirements
requested by your team and explain how they will be met through the API design approach.
Additionally, analyse the suggested application to determine aspects that could be extended with
suitable APIs.
Once all requirements and designs are finalized, proceed to develop an application that utilizes
APIs for specific purposes, implementing it within a suitable development environment while
adhering to the designed specifications. Utilize existing application frameworks as necessary to
implement APIs. Upon implementation, testing of the application is essential, along with
reviewing and reflecting on the APIs used. Evaluate the performance of the APIs critically within
the application and discuss strategies for providing a data security report. Design and conduct a
'white box' test of the application, recording the results, followed by 'black box' tests, also required.
Utilize obtained results to identify and forecast necessary development updates for the application,
then proceed to update the application accordingly.
Recommended Resources
Please note that the resources listed are examples for you to use as a starting point in your
research – the list is not definitive.
Textbooks
Spencer, T. et al. (2015) Securing the API Stronghold: The Ultimate Guide to API
Security.
1st Ed. Kindle. Amazon.
Websites
developers.google.com: Google Developers (Development Tools)
khronos.org: The Khronos Group “Vulkan API” (Development Tool)
Links
This unit links to the following related units:
Unit 15: Fundamentals of AI & Intelligent Systems
Unit 36: Application Development
Learning Outcomes and Assessment Criteria
D3 Construct an
P3 Build on an existing M3 Develop an application utilising
application framework application that utilises multiple APIs, following
to implement an API. an API. the designs in LO2.