Skip to main content

API First Quickstart Guide

Welcome to API First. This guide helps you get started with building, testing, and deploying your API using our self-service onboarding process.

This Quickstart is part of the broader self-service onboarding section, which includes:

Prerequisites​

Before you begin, make sure you:

Step 1: Set up access​

Apigee​

  • Log in to the WPP Developer Dashboard.
  • Ensure Test - Apigee EDGE Non Prod is under My Apps.
    If not, go to Add apps, search for it, and add it.
  • Create a Jira ticket to set up your Apigee user account.

GitHub​

  • In the WPP Dashboard, go to:
    Add apps > Search for GitHub > Add WPPOpen GitHub.
  • Visit the WPP Open GitHub organization.
  • Ensure you have an active GitHub account with MFA.

Step 2: Describe your API​

Submit the following details via the onboarding Jira ticket:

  • A brief description of your API
  • Contact info of the API owner
  • Expected go-live date

This information improves visibility and prevents duplication of similar APIs.

Step 3: Create your API Proxy in Apigee​

  • Open Apigee via Test - Apigee EDGE Non Prod.
  • Navigate to:
    API Proxies > + Proxy > Select Reverse Proxy.
  • Fill in:
    • Proxy details
    • Target URL
    • Base paths
  • Skip policy setup (defaults are sufficient)
  • Under Virtual Hosts:
    • Deselect secure
    • Select vhost_https
  • Review and Create & Deploy your proxy.

Step 4: Configure and Deploy the API​

  • Edit the proxy configuration.
  • Set up a GitHub repository using the wpp--apigee--factory--master-repo as a template.
  • Export Postman collections and environment files, and include them in your repo.
  • Configure CI/CD:
    • Copy .github/workflows/CI_CD.yml
    • Set secrets (e.g. APIGEE_USER, etc.)
  • Add your spec.yml (OpenAPI spec) to the repo.
  • Push to the develop branch to run the pipeline.
  • Create a pull request to main and describe your work.
  • Notify the API First team of your intended production date.
  • The API First team will verify and deploy it on your chosen date.