Getting Started

📘 # Getting Started

This guide helps developers begin using the Gitdigital API Gateway.

Requirements

Kubernetes cluster (EKS recommended)

AWS KMS key for signing

Docker or GHCR access

Helm + Helmfile installed

Quick Setup

Clone the repository:

git clone https://github.com/Gitdigital-products/api-gateway cd api-gateway

Deploy to staging:

helmfile apply -e staging

Verify the health endpoint:

GET /health

First Signed Transaction

1. Create a signing profile in AWS KMS

2. Configure your KMS key in values-production.yaml

3. Use the /tx/send endpoint with a payload containing to/from/nonce/value

4. Gateway signs the transaction using KMS and broadcasts it to the chain