With the tools your team uses
Connect your tools through APIs
Learn to read API documentation, prepare a request and understand its response so you can connect the tools your team already uses.
Before we begin
Have built a simple workflow and mapped fields, or have equivalent experience. We agree the tools, level and classroom setup before starting; coding is not required. The materials support practice without connecting real accounts.
We choose the automation platform and services to fit your environment. The downloadable case uses documentation and simulated HTTP/JSON responses, without keys or real accounts. If an edition includes execution in a tool, we agree and check the account, plan, permissions, test service and usage beforehand. Reviewing files supports the reasoning practice but does not demonstrate an executed connection.
Learn methods and criteria you can apply with your own tools. We adapt the exercises to your team’s environment and confirm the features, access and usage needed for the agreed practice.
See preparation and terms →By the end you will be able to
- 01
Interpret an endpoint, its parameters and the JSON response it returns.
- 02
Prepare a mapping that preserves identifiers and distinguishes missing information.
- 03
Recognise authentication, pagination, limits and errors to decide what to do next.
- 04
Explain when to use a connector, an HTTP request or technical help.
What we will work on
When a connector does not cover what you need, API documentation helps you understand what can be queried and what access it requires. Work through a pending-orders case: read the request, follow the response and make exceptions clear before choosing how to connect.
01Understand requests and responses
Endpoint documentation, method, parameters, JSON fields and missing information. Turn a team need into a bounded request.
You will work on
- Turn the need to review pending orders into an endpoint and its parameters.
- Distinguish the method, path and query from fields returned by the server.
- Map identifier, status and delivery date without inventing a date when one is missing.
- Practice
- Read the classroom API reference and complete the mapping for the first page of orders.
- How you will check it
- A request consistent with the documentation and a mapping with a source and rule for each field.
02Access and work through the data
Authentication without sharing credentials, result pages and request limits. What to check before treating a list as complete.
You will work on
- Identify the authentication required and who prepares access, without copying secrets into materials.
- Follow the second-page cursor, retain the filter and check when the query ends.
- Distinguish page size from request limits and record missing information.
- Practice
- Combine two simulated responses into a three-order list and preserve one unconfirmed date.
- How you will check it
- Three unique identifiers, both pages recorded and a query marked complete only when the traversal ends.
03Diagnose and choose a connection approach
Error responses, bounded retries and useful handover notes. Choose a connector, HTTP or technical intervention to fit the case.
You will work on
- Distinguish invalid credentials, a request limit and a service error.
- Choose a bounded response and document when to stop and request intervention.
- Compare an available connector, an HTTP request and additional development against what the documentation supports.
- Practice
- Review 401, 429 and 500 responses and prepare a connection decision with an owner, tests and outstanding questions.
- How you will check it
- A record explaining each error and the next step, without unlimited retries or integration promises.
Three orders, two pages and an unconfirmed date.
Classroom example with fictional data
Query pending orders from a fictional supplier using documentation, simulated requests and responses. Prepare a list from two pages and handle an unconfirmed field and three error responses. The automation platform and actual services are chosen for each edition.
Fictional classroom case. Operations needs to review a supplier’s pending orders. The available connector does not provide that query. The exercise API returns two pages; one order has no confirmed delivery date. Work with prepared files, without a server or real accounts.
- Starting point
- The first page shows two orders and a cursor to continue. Treating it as complete would omit the third order.
- First reading
- The first attempt keeps only the first page and fills the missing date with another order’s date.
- What we review
- Check next_cursor before closing the query and preserve each identifier. Leave the missing date unconfirmed; then explain how you would handle invalid authentication, request limits and service errors.
- Result
- The classroom solution combines ORD-101, ORD-102 and ORD-103. ORD-102 keeps an unconfirmed date, and the record distinguishes completed pagination from stopping because of an error.
Check before drawing conclusions.
The first page is not the whole list
Before review
Two orders; ORD-102 takes another record’s date.
After review
Three orders from two pages; ORD-102 remains unconfirmed.
The cursor indicates more results. A null value does not authorise filling in missing information.
Three errors, three different decisions
We review the simulated AUTH-401, RATE-429 and ERROR-500 responses to a read query. They are not results of real requests.
| Case response | What we check | Expected decision |
|---|---|---|
| 401 · AUTH-401 | The response indicates an authentication problem. Knowing the endpoint does not demonstrate access. | Stop and review access with its owner, without copying keys or repeating the query automatically. |
| 429 · RATE-429 | The case’s Retry-After header specifies 30 seconds. | Respect the wait. Only when repeating the read is permitted, keep a maximum of two total attempts, including the initial one. |
| 500 · ERROR-500 | The server returns an error; retain the request, status and context. | Apply only the agreed bounded read handling. If the error persists, stop and escalate; do not create a retry loop. |
Swipe to see all columns.
The same “retry” button does not resolve all three cases: the evidence must justify the next action and who owns it.
What we cannot conclude
- These decisions follow this exercise’s contract and limit. A real integration requires checking the service documentation, permissions and retry policy.
- Reviewing files demonstrates the expected diagnosis; it does not demonstrate a connection or real execution.
Before calling it complete
- The list contains all three identifiers once and records both pages.
- ORD-102’s missing date remains unconfirmed; it is not copied from another order.
- The connection decision explains access, limits, errors and when another person needs to intervene.
Sessions to put it into practice.
Reference edition · 4 h live
Reference edition: 4 live hours across 2 sessions of 2 hours. Practice, individual evidence and short feedback take place during the sessions; no mandatory between-session tasks are added.
- Session 12 h
Read and prepare a query
From the need to the endpoint: method, parameters, JSON response, mapping and access preparation. Practise with the case’s simulated files.
By the endA request worksheet and reviewed mapping, with missing information and access requirements visible.
- Session 22 h
Complete, diagnose and decide
Work through two pages, handle error responses and choose a connector, HTTP or technical help. Individual evidence and feedback take place in the session.
By the endA checked list and documented connection decision, including limits and the next owner.
If your team needs to go further
- This extension has its own 4 hours; it does not replace the hours of an introductory automation course.
- Advanced OAuth, request signing, custom connectors and API development need a separate scope.
- Production integrations, real data and service usage are agreed separately; no platform is predetermined.
An individual piece of work to close.
Individually complete a request worksheet, the order list and a connection decision. Explain a missing field and your response to an error; the trainer reviews evidence and gives feedback within the 4 hours.
Prepare the request
- Pass
- Identifies method, path and parameters from the reference and distinguishes required access without copying a key.
- Needs review
- The request does not answer the need or confuses a parameter with an output field.
Preserve and complete the data
- Pass
- Combines both pages, preserves all three identifiers and leaves the missing date unconfirmed.
- Needs review
- Omits a page, repeats an identifier or invents ORD-102’s date.
Diagnose within limits
- Pass
- Distinguishes 401, 429 and 500, explains a bounded response and knows when to stop and escalate.
- Needs review
- Retries without a limit, changes permissions without an owner or treats an error as an empty query.
Choose and explain the next step
- Pass
- Justifies a connector, HTTP or technical help with documentation evidence and outstanding questions.
- Needs review
- Chooses by brand preference or promises an integration that has not been checked.
The trainer reviews the task and explains the result within the agreed course time. Additional reassessment is agreed for each edition.
Learn with someone who develops projects for companies.
Borja Martínez
The Optimal Flow consultant
Over two years of experience developing projects for companies across industries and sizes.
Borja is the planned trainer for this area. Case preparation, setup, dates and his availability are confirmed when the edition is agreed.
A case to understand the connection.
Documentation, simulated requests and responses, blank worksheets and worked examples for practice without real accounts.
- Practice guide and timings
- Fictional API reference
- Simulated requests
- Simulated HTTP/JSON responses
- Blank mapping
- Worked mapping example
- Blank order list
- Worked order-list example
- Blank test record
- Worked test example
- Blank connection decision
- Worked decision example
- Checks and expected solution
With guidance, practice and support.
Each delivery includes working materials, feedback on practical work and assessment against the agreed objectives.
Materials you can keep
Downloadable, versioned guides, exercises and review criteria for internal use.
To prepare and complete the delivery
A short recommendation, an editable communications kit and a group learning report.
TOF’s own certificate
A certificate of achievement after the agreed assessment. It is not a vendor certification.
A month of email support
On the content covered, up to two accumulated hours for the whole group.
Your team carries out the practice. Implementation services are agreed separately. See the scope →