Discover what an API is, its elements and the actions and parameters exchanged between systems, and learn JSON and XML formats to represent exchanged objects for business analysts' requirements.

Describe how objects obtain unique identifiers, like parcel IDs and shipment IDs, generated on the server as references, enabling status queries and globally unique identifiers (GUID) using 32 hex symbols.

Learn to interpret architectural diagrams, their elements, and how to build them to visualize the main systems in the requirements, and understand why this is important for the Bas.

Explore the types of architectural diagrams and how each provides an overview from different perspectives, including high level software architecture diagrams, integration diagrams with protocols, and application architecture diagrams.

Explore an application architecture diagram for a middleware shipping system, outlining user interfaces for customers and admins, and services such as delivery notification and shipping API, plus connectors to providers.

Explore how to model alternatives in sequence diagrams by using opt and out frames, showing optional steps and multiple alternatives for conditions like free shipping thresholds and country support.

Explore the client side of an api by detailing how to specify input parameters and handle server responses for creating parcels and shipments.

Organize api input fields in the specified order and add a comments column to track open questions, clarifying mappings for individual vs business users or separate mapping tables.

Define input parameters for a method by listing name, data type, and allowed values. Specify optional defaults, validations, and cross-parameter rules to ensure consistent server requests.

Define the processing logic by validating input parameters, calculating results, creating or modifying objects, and calling external methods to ensure valid data and correct outcomes.

This lecture covers formats for requirements, targeting server-side and client-side audiences, detailing input parameters, validations, processing logic, and output parameters, and explains given-when-then or free-form documentation approaches.

Explore restful apis and representational state transfer principles; learn stateless request models, resource identifiers, http methods for create, read, modify, delete, and json as the exchange format.

Filter and paginate data using query parameters to limit results. Retrieve each page with a page number and per-page limit to prevent denial of service attacks.

Master RESTful API versioning with URI path, querystring, or header approaches. See how servers choose the method and how clients specify the exact version via documentation.