nady4 / developers

01 / Quickstart

The API is public — no key, registration, or OAuth required. You can start immediately:

curl -X POST https://www.nady4.com/api/newsletter \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]"}'

Successful response: { "ok": true }

02 / Endpoint

POST /api/newsletter

• Subscribes an email address to the newsletter list.
• Body (JSON): {"email": "[email protected]"}
• Idempotent: subscribing the same address twice does not create duplicates.

Error format

All errors are JSON with a stable code and a resolution hint:

{
  "ok": false,
  "message": "invalid_email",
  "error": {
    "code": "invalid_email",
    "message": "The 'email' field is missing or not a valid email address.",
    "hint": "Use a valid address like [email protected] (max 254 characters)."
  }
}

Possible codes: invalid_body, invalid_email, method_not_allowed, not_found, storage_failure.

03 / Spec and reference

• OpenAPI 3.1: /openapi.json · /openapi.yaml — the full API definition for tooling and agents.
• RFC 9728: /.well-known/oauth-protected-resource — protected-resource metadata and declared scopes.
• llms.txt: /llms.txt — the agent-facing site guide.
• Sitemap: /sitemap.xml — all indexable URLs.

04 / Sandbox and limits

There is no separate staging environment: the production endpoint doubles as the sandbox, so you can test with your own address risk-free. There is no documented rate limit at the edge; if you plan to subscribe many addresses, give a heads-up via [email protected].

Site content is licensed CC BY-SA 4.0; the API requires no authentication and all declared scopes are empty by design (see the RFC 9728 metadata).