Core flows¶

What this section is

Each page here follows one thing a person (or APIM itself) does, and shows which tables get written or read, in what order, and which columns link one step to the next.

The pages are ordered roughly the way an API goes through its life. First an API creator designs and ships an API. Then a developer finds it and uses it. Finally admins keep everything under control.

The end-to-end journey¶

This diagram shows the "happy path" from an idea to a working API call. Each box is a flow page.

flowchart LR
    A[Create an API] --> B[Deploy a revision]
    B --> C[Publish it]
    C --> D[Create an application]
    D --> E[Subscribe]
    E --> F[Generate keys]
    F --> G[Get a token and call]

The first three boxes happen in the Publisher, and the last four in the Developer Portal.
The final box is where the Gateway and Key Manager take over.

All flows¶

#	Flow	Who does it	Main tables
1	Setup & first user	APIM at startup, a user logging in	`UM_USER`, `AM_KEY_MANAGER`, `AM_POLICY_*`, `AM_SUBSCRIBER` + DefaultApplication
2	Create an API	API creator (Publisher)	`AM_API`, `AM_API_URL_MAPPING`, `AM_SCOPE`, `IDN_OAUTH2_SCOPE`, `GOV_REQUEST`
3	Create a new version	API creator (Publisher)	`AM_API`, `AM_API_DEFAULT_VERSION`
4	Deploy a revision	API creator (Publisher), Gateway	`AM_REVISION`, `AM_GW_API_ARTIFACTS`, `AM_DEPLOYMENT_REVISION_MAPPING`, `AM_GW_REVISION_DEPLOYMENT`
5	Change lifecycle state	API publisher	`AM_API.STATUS`, `AM_API_LC_EVENT`
6	Create an API product	API creator (Publisher)	`AM_API` (type `APIProduct`), copied `AM_API_URL_MAPPING` rows, `AM_API_PRODUCT_MAPPING`
7	Create an application	Developer (Dev Portal)	`AM_SUBSCRIBER`, `AM_APPLICATION`
8	Subscribe to an API	Developer (Dev Portal)	`AM_SUBSCRIPTION`
9	Generate keys	Developer (Dev Portal), Key Manager	`AM_APPLICATION_REGISTRATION`, `AM_APPLICATION_KEY_MAPPING`, `IDN_OAUTH_CONSUMER_APPS`
10	Get a token & call the API	Client app, Key Manager, Gateway	Nothing written for JWTs or calls. `AM_API_KEY` for API keys
11	Manage throttling policies	Admin (Admin Portal)	`AM_POLICY_*`, `AM_API_THROTTLE_POLICY`, `AM_CONDITION_GROUP`
12	Revoke & delete	Developer, admin, Key Manager	`AM_REVOKED_JWT`, `IDN_INVALID_TOKENS`, `AM_APP_REVOKED_EVENT`, cascading deletes
13	Approval workflows	Any of the above, plus an approver	`AM_WORKFLOWS`
14	Governance check	APIM governance engine	`GOV_*`
15	Create an AI API	API creator (Publisher)	`AM_LLM_PROVIDER`, `AM_API_AI_CONFIGURATION`

Reading the flow pages

Each page starts with a small sequence diagram, then walks through the steps with example rows. It finishes with a read-only SQL query you can run to see the result in your own database. See How to read this guide for the diagram notation.

Different in 3.x

3.x has most of the same flows. The big difference is step 4: instead of revisions, 3.x publishes APIs straight to gateway labels. See the 3.x flows.