Quick Start

Prerequisites

• An Apiway tenant (register here if you haven’t already)
• An OpenAPI 3.x specification file (.yaml or .json)

Deploy via the Platform API

Apiway is API-first. The fastest path from spec to production is a single API call.

1. Upload your OpenAPI specification

   curl -X POST https://core.api.apiway.net/v1/programmes \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "My First API",
       "specification": "<base64-encoded OAS>"
     }'

   This kicks off the Quick Deploy pipeline — an 8-step server-side process that handles everything automatically.

2. Track progress

   Poll the returned programme ID to watch each step complete:

   curl https://core.api.apiway.net/v1/programmes/{id}/progress \
     -H "Authorization: Bearer $TOKEN"

   The pipeline runs through: validation, compliance check, recommendations, governance submission, approval, deployment, subscription creation, and activation.

3. Call your API

   Once deployed, your API is live behind the gateway:

   curl https://alpha.gateway.apiway.net/my-first-api-v1/resources \
     -H "Authorization: Bearer $API_TOKEN"

Deploy via the Management UI

1. Navigate to the API Catalogue — Open the management portal and go to Cartography > APIs.

2. Upload your spec — Click Quick Deploy, drag your OAS file, and confirm. The progress bar tracks each step in real time.

3. Review governance — If your organisation has approval workflows configured, the API enters a governance review. Approvers are notified automatically.

4. Go live — Once approved, the API deploys to your configured gateway. You’ll see it in the catalogue with a live status, endpoint URL, and subscription details.

Built-in assistant

Every page in the management UI has a ? button in the top right corner. Click it to open the help panel — it shows guidance specific to the page you’re on, common tasks, and links directly to the relevant documentation. You’re never left guessing what to do next.

What Just Happened?

Behind the scenes, Apiway:

1. Validated your OAS against the OpenAPI 3.x standard
2. Scored your spec for compliance with your organisation’s API design standards
3. Generated recommendations for improving your API design
4. Applied security — OAuth 2.0 client credentials and per-operation scopes (even if your OAS had no security defined)
5. Submitted the API to your governance workflow for approval
6. Deployed proxy and policy documents to your gateway
7. Created a subscription with credentials for immediate use
8. Activated the deployment using blue-green revision promotion