SparkGlim Developer
Give your assistant the right context.

Prepare an integration prompt from verified SparkGlim documentation. Select a product, stack and assistant, then copy or download the public brief.
Choose your API product
Choose your technology stack
Choose your assistant
Public campaigns & participation

Display eligible public campaign information and connect to the supported participation journey.
Prerequisites: Use only public records and the exact access rules of each operation.
Verified scope and limitations: Public data does not include private buyers, donors, account records or unpublished campaigns.
# SparkGlim — Public campaigns & participation

Help me implement a SparkGlim integration using only the verified public sources below. Keep the selected API product separate from the other access models.

Choose your technology stack: TypeScript
Choose your assistant: Codex
Documentation language: en

## Intended experience

Display eligible public campaign information and connect to the supported participation journey.

## Prerequisites

Use only public records and the exact access rules of each operation.

## Architecture and trust boundaries

Use the selected language for backend HTTP requests and keep private authentication server-side. Do not invent an official SDK or package installation command.

Use the selected assistant as a coding aid. Explain proposed changes before implementation and keep the public sources authoritative over generated suggestions.

## Authentication and permissions

Account approval, verified domains, scopes, member permissions and campaign visibility determine access. A country or language choice never enables payments or changes campaign currency.

## Verified operations for this brief

Only source-verified implemented operations appear below. Unverified or retired operations are intentionally excluded; do not replace a missing capability with a private dashboard endpoint.

Field names, types and validation below are protocol requirements, not sample customer records.

### GET /api/public/payment-methods/:campaignId — Campaign payment options

Lists enabled checkout method names for an approved campaign’s selling country, currency and client context without exposing provider secrets.

Access model: Public API

Request contract:
- campaignId (path; string; Required): Existing campaign record within the caller’s account and any narrower campaign credential. Validation: UUID or documented resource identifier.
- app_type (query; enum; Optional): Existing caller context used to select Web or User App configuration; it grants no extra permissions. Validation: user selects user_app; otherwise web.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"methods":["item"],"currency":"string","country":"string"}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Open the returned checkout URL. SparkGlim Server owns prices, methods, payment verification and fulfillment; browser returns are navigation only.

https://developer.sparkglim.net/reference/public/public-get-api-public-payment-methods-campaignId

### GET /api/public/tickets/public-verify — Public ticket verification

Forwards bearer ticket-credential verification to the Web ticket reader and preserves its status and payload; it does not perform admission.

Access model: Public API

Request contract:
- code (query; string; Required): The existing resource credential or verification code required by this endpoint; never publish a real OTP or ticket secret. Validation: valid ticket credential.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"ticket_code":"string","checked_in":"boolean","checked_in_at":"null","details_revealed":"boolean","campaign":{"title":"string","slug":"string","venue":"string"},"ticket_name":"string"}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Open the returned checkout URL. SparkGlim Server owns prices, methods, payment verification and fulfillment; browser returns are navigation only.
Treat ticket codes as bearer credentials. Current handler can reveal attendee details after check-in; public verification never authorizes check-in.

https://developer.sparkglim.net/reference/public/public-get-api-public-tickets-public-verify

### GET /api/public/blog — Published articles

Lists published articles with search, category, featured, limit and offset filters, returning the exact total and list pagination.

Access model: Public API

Request contract:
- category (query; string; Optional): Configured campaign category or approved settings category, depending on the resource. Validation: category slug.
- search (query; string; Optional): Text filter applied to the existing published records selected by this endpoint. Validation: search text.
- featured (query; string; Optional): Requests the existing featured-article filter when its value is true. Validation: true.
- limit (query; number; Optional): Maximum records returned in this page; the endpoint’s fixed bound applies. Validation: 1–30 default10.
- offset (query; number; Optional): Zero-based number of published article records to skip before the requested page. Validation: >=0 default0.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":["item"],"count":"number","limit":"number","offset":"number"}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Open the returned checkout URL. SparkGlim Server owns prices, methods, payment verification and fulfillment; browser returns are navigation only.

https://developer.sparkglim.net/reference/public/public-get-api-public-blog

### GET /api/public/blog/categories — Article categories

Lists active article categories ordered by configured position and post count.

Access model: Public API

Request contract:
No documented request fields.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":["item"]}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Open the returned checkout URL. SparkGlim Server owns prices, methods, payment verification and fulfillment; browser returns are navigation only.

https://developer.sparkglim.net/reference/public/public-get-api-public-blog-categories

### GET /api/public/blog/:slug — Published article detail

Returns a published article and up to four related published posts, and increments the article view counter.

Access model: Public API

Request contract:
- slug (path; string; Required): URL-friendly identifier for the existing campaign or published article. Validation: public slug.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"post":{"id":"string","slug":"string","title":"string","status":"string"},"relatedPosts":["item"]}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Open the returned checkout URL. SparkGlim Server owns prices, methods, payment verification and fulfillment; browser returns are navigation only.
Reading an article increments its view counter. This GET is not a mutation-free inspection probe.

https://developer.sparkglim.net/reference/public/public-get-api-public-blog-slug

### GET /api/public/homepage/discovery — Public campaign discovery

Searches the strict public campaign index with product, country, lifecycle, location and date filters, returning exact pagination and disclosure-gated facts.

Access model: Public API

Request contract:
- q (query; string; Optional): Search text matched against public campaign title, description, organizer and applicable location or beneficiary fields. Validation: <=100.
- country (query; string; Optional): Filter by the campaign’s configured country; this does not enable payment methods or convert currency. Validation: ISO2.
- location (query; string; Optional): Public campaign location or discovery location filter; separate from the financial selling country. Validation: <=100.
- type (query; enum; Optional): Supported resource kind, reaction kind or discovery campaign filter specified by this endpoint. Validation: all | ticketing | voting | donation.
- status (query; enum; Optional): Requested supported lifecycle state; account and campaign approval rules still control publication and access. Validation: all | active | upcoming | ended | postponed.
- sort (query; enum; Optional): Selects the server’s supported featured, latest or closing-date ordering. Validation: featured | latest | ending.
- date (query; enum; Optional): Restricts discovery to the documented event/campaign date window in the existing server filter. Validation: all | today | tomorrow | weekend | month.
- page (query; integer; Optional): Requested result page within the endpoint’s documented numbering; retain server pagination metadata. Validation: 1–1000000.
- limit (query; integer; Optional): Maximum records returned in this page; the endpoint’s fixed bound applies. Validation: 1–24 default12.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"entries":["item"],"countries":["item"],"locations":["item"],"pagination":{"page":"number","limit":"number","total":"number","pages":"number","hasMore":"boolean"},"available":"boolean"}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Return only the records permitted by account, campaign and visibility settings.

https://developer.sparkglim.net/reference/public/public-get-api-public-homepage-discovery

### GET /api/public/homepage/campaigns — Homepage campaign feed

Returns a curated active public campaign feed of up to72 records for an optional country; it is not a paginated full index.

Access model: Public API

Request contract:
- country (query; string; Optional): Filter by the campaign’s configured country; this does not enable payment methods or convert currency. Validation: ISO2.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"campaigns":["item"],"countries":["item"],"available":"boolean"}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Active public campaigns only, at most72; no pagination.

https://developer.sparkglim.net/reference/public/public-get-api-public-homepage-campaigns

### GET /api/public/homepage/awards — Public awards feed

Returns up to200 public voting campaigns in approved, ended or postponed states, ordered by featured status and creation date.

Access model: Public API

Request contract:
- country (query; string; Optional): Filter by the campaign’s configured country; this does not enable payment methods or convert currency. Validation: ISO2.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"campaigns":["item"],"countries":["item"],"available":"boolean"}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Voting campaigns only, at most200; no pagination.

https://developer.sparkglim.net/reference/public/public-get-api-public-homepage-awards

### GET /api/public/countries — Active country catalog

Returns the active admin-managed country catalog and default currencies; this is not a list of enabled payment corridors.

Access model: Public API

Request contract:
No documented request fields.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":[{"code":"string","name":"string","phoneCode":"string","isDefault":"boolean","currency":"object"}]}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Catalog presence does not activate payments or country domains.

https://developer.sparkglim.net/reference/public/public-get-api-public-countries

### GET /api/public/blog/:slug/reactions — Read article reactions

Counts the supported reactions on a published article and identifies the current visitor’s selections without returning other visitor identities.

Access model: Public API

Request contract:
- slug (path; string; Required): URL-friendly identifier for the existing campaign or published article. Validation: public slug.
- visitorId (query; string; Optional): Existing visitor identity used to retrieve or toggle that visitor’s article reaction. Validation: visitor identity.
- profileToken (query; string; Optional): Token of an existing verified community profile; this endpoint does not create that identity. Validation: existing verified community profile.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"counts":{"like":"number","love":"number","insightful":"number","celebrate":"number","clap":"number"},"mine":["item"]}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.

https://developer.sparkglim.net/reference/public/public-get-api-public-blog-slug-reactions

### GET /api/public/blog/:slug/comments — Approved article comments

Lists up to500 approved comments on a published article in ascending creation order; private author contact is not returned.

Access model: Public API

Request contract:
- slug (path; string; Required): URL-friendly identifier for the existing campaign or published article. Validation: public slug.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":["item"]}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Up to500 approved comments, oldest first; no pagination.

https://developer.sparkglim.net/reference/public/public-get-api-public-blog-slug-comments

### GET /api/public/qr/ticket/:code — Ticket QR image

Returns a branded binary PNG for the supplied ticket credential at a bounded image size; rendering does not grant ticket ownership.

Access model: Public API

Request contract:
- code (path; string; Required): The existing resource credential or verification code required by this endpoint; never publish a real OTP or ticket secret. Validation: UUID or documented resource identifier.
- size (query; integer; Optional): Requested output QR image width bounded by the existing renderer. Validation: 128–1024 default512.

Success HTTP status: 200

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Availability is verified from source, not a live production guarantee.
Binary PNG response, not JSON. Possessing or rendering a code does not authorize check-in.

https://developer.sparkglim.net/reference/public/public-get-api-public-qr-ticket-code

### GET /api/participants/search — Public nominee or campaign code lookup

Finds an approved nominee or public voting campaign by code or slug using the current public visibility and active-category boundary.

Access model: Public API

Request contract:
- code (query; string; Required): The existing resource credential or verification code required by this endpoint; never publish a real OTP or ticket secret. Validation: nominee/participant/campaign code or campaign slug; q accepted as alias.

Success HTTP status: 200
Expected response contract: {"success":"boolean","resultType":"string","participant":{"id":"string","name":"string","bio":"null","category":"null","vote_count":"null","show_vote_count":"boolean","participant_code":"string","nominee_code":"null","image_url":"null"},"campaign":{"id":"string","title":"string","slug":"string","status":"string","campaign_type":"string","vote_price":"number","image_url":"null","banner_url":"null"}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

This Web handler has no dedicated limiter in its source; upstream controls may apply.

Availability is verified from source, not a live production guarantee.
Return only the records permitted by account, campaign and visibility settings.

https://developer.sparkglim.net/reference/public/public-get-api-participants-search

### GET /api/public/voting-counts/:campaignId — Visibility-gated public vote counts

Returns completed vote totals only for a publicly visible voting campaign, approved nominees and active categories when counts are explicitly public.

Access model: Public API

Request contract:
- campaignId (path; string; Required): Existing campaign record within the caller’s account and any narrower campaign credential. Validation: UUID or documented resource identifier.

Success HTTP status: 200
Expected response contract: {"success":"boolean","data":{"visible":"boolean","voteCounts":{}}}

Validation and recovery: Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

This Web handler has no dedicated limiter in its source; upstream controls may apply.

Availability is verified from source, not a live production guarantee.
Return only the records permitted by account, campaign and visibility settings.

https://developer.sparkglim.net/reference/public/public-get-api-public-voting-counts-campaignId

## Credential and request handling

Never add real keys, session tokens, private URLs, customer contacts, OTPs or unpublished campaign records. Use placeholders and request project context without asking for secrets.

## Validation and recovery

Validate inputs with the documented schema. Preserve business references and required idempotency keys across retries, use fresh signing nonces, and do not retry validation or permission errors unchanged.

## Central checkout handoff

For paid participation, create the supported checkout session on the server and open its returned checkout.sparkglim.net URL. SparkGlim Server owns provider selection, payment verification and fulfillment. Do not add browser payment verification or polling.

## Verified scope and limitations

Public data does not include private buyers, donors, account records or unpublished campaigns.

Source implementation does not establish production availability. Review the current API status and documented origin before using an operation. If the required API is unavailable, stop and ask for the approved next step; do not invent a replacement or call a private dashboard API.

## Authoritative public sources

- https://developer.sparkglim.net/public-api
- https://developer.sparkglim.net/responses
- https://developer.sparkglim.net/security
- https://developer.sparkglim.net/api-status

## Repository instructions to retain

Read the project’s existing instructions first. Reuse established components and transport helpers, preserve unrelated work, and propose focused contract tests. Do not run live payments, account mutations or messages without explicit authorization.

Explain the architecture, list the exact documented operations, then provide a minimal backend/client implementation plan. Mark unavailable capabilities explicitly and ask for missing project context without requesting secrets.
Copy this brief into your assistant or add the downloaded file to your project. Selecting an assistant does not connect an account or send the prompt.
Use public documentation and placeholders only. Keep credentials, customer information and private campaign data out of assistant prompts.
Public campaigns & participation

Continue building
