giip

Vercel Management API Guide (v1.2)

GIIP platform provides APIs for managing Vercel project configurations and querying deployment history. This API standardly uses the Sk3 (JSON data-based) interface to process requests.

🔌 Go to Vercel Status →

📋 Overview

The Vercel Management API is used to query Vercel project configurations registered in GIIP or to monitor the latest deployment history.

🔐 Authentication & Security

All requests must include the GIIP common authentication headers.

  • Header:
    x-giip-ak
    ,
    x-giip-sk
  • Body Context: Sk3 interface (uses
    jsondata
    field)

📡 API Details (Sk3)

1. Retrieve Vercel Configuration List (VercelConfigsList)

  • Command:
    text=VercelConfigsList
  • jsondata:
    {"csn": 123}
    (Optional: Project identifier)
  • Description: Returns all currently registered Vercel configuration information and synchronized Vercel project names.

2. Create Vercel Configuration (VercelConfigCreate)

  • Command:
    text=VercelConfigCreate
  • jsondata:
{
  "csn": 123,
  "configName": "Production_Main",
  "vercelProjectName": "giip-next-app",
  "vercelToken": "vcl_token_...",
  "vercelTeamId": "team_xxx",
  "vercelProjectId": "prj_xxx"
}

3. Update/Delete Vercel Configuration (VercelConfigUpdate / VercelConfigDelete)

  • Update:
    text=VercelConfigUpdate
    +
    {"vcId": 123, ...}
  • Delete:
    text=VercelConfigDelete
    +
    {"vcSn": 123}
    (or
    vcId
    )

4. Retrieve Deployment History (VercelDeploymentsList)

  • Command:
    text=VercelDeploymentsList
  • jsondata:
    {"vcId": 123, "limit": 20}
  • Description: Retrieves a list of Vercel deployments corresponding to a specific configuration (
    vcId
    ) in reverse chronological order.

🛡️ Using Sk3 (High-fidelity Logging)

The Vercel Management API has adopted the

giipApiSk3
interface as its standard from the design phase. It provides detailed execution context and error tracing for all configuration management and query requests.

  • Endpoint:
    https://giipfaw.azurewebsites.net/api/giipApiSk3
  • Advantages: In case of Vercel token errors or deployment status synchronization failures, it automatically records the caller's IP, User-Agent, and detailed server-side StackTrace to help diagnose integration issues quickly.
  • Usage Tip: When sending requests with many parameters like
    VercelConfigCreate
    , utilizing the
    jsondata
    object structure allows for the safe and complete transmission of complex token values while logging the details.

Version: 1.3 Last Updated: 2026-04-11 Source:

giipv3/public/help/api-vercel.en.md


Related Documents: