Demo Web App API

Disclaimer: This document is an example only intended to show the format for the workflow. It is not real-world customer-ready API documentation.

This document is a usage guide for the demo-webapp service exposed through Kong under the /demo base path. It accompanies the OpenAPI specification and is intended for developers integrating with the demo-webapp API.

Base URL

https://api.staging.9fin.com/demo

The proxy host varies by environment — replace api.staging.9fin.com with the host for the environment you're targeting. The /demo suffix is fixed and identifies the demo-webapp service in Kong.

Authentication

The API accepts:

  • API key in the apikey header:
    apikey: <key>
    

Endpoints

GET /healthz — health check

Returns 200 OK with a StatusMessage payload when the upstream service is reachable.

{ "status": "success", "msg": "OK" }

Use this for liveness probes and synthetic monitoring.

GET /api/print-headers — print incoming headers

Logs the incoming request headers to the service's stdout and echoes them back in the response body. Useful for verifying which headers Kong is forwarding to the upstream service.

{ "status": "success", "headers": { "host": "...", "user-agent": "..." } }

Support

Questions about the demo service belong in #ddep-team-platform-engineering on Slack. Issues with Kong routing or the release workflow itself go to #ddep-team-platform-engineering as well.