Skip to content
Grona Developers
The Public API is available on request. Email support@grona.ai to get access.

Overview

Create, launch and manage Grona campaigns from your own systems.

Grona Public API 1.0.0

Section titled “Grona Public API 1.0.0”

The Grona Public API v1 lets your backend create website campaigns, open them in the Grona visual editor, set them live, check that the Grona snippet is installed, and fetch grants for the mobile SDKs.

The API is available on request. Email support@grona.ai to get access.

  • Base URL: https://api.grona.ai. Every path starts with /v1.
  • Authentication: a workspace secret key, sent as Authorization: Bearer grona_sk_<keyId>_<secret> or as X-API-Key: grona_sk_<keyId>_<secret>. Call the API from your servers only. See Authentication.
  • Workspace: resolved from the key. It never appears in a URL or a request body.
  • Envelope: success is { "data": ..., "meta": { "workspaceId": ... } } and failure is { "error": { "code": ..., "message": ... } }. A 429 or 503 body may not use the envelope. See Errors.
  • Compatibility: v1 can gain fields, endpoints, optional parameters and enum values, so ignore anything you do not recognise. See Versioning.

The endpoints under Mobile SDK endpoints are called by the Grona Android and iOS SDKs, not by your code. They are listed so you can allow the traffic and understand what the SDKs send.

Operations

Section titled “Operations”
GET
/v1/campaigns
POST
/v1/campaigns
GET
/v1/campaigns/{campaignId}
DELETE
/v1/campaigns/{campaignId}
PATCH
/v1/campaigns/{campaignId}
PATCH
/v1/campaigns/{campaignId}/status
POST
/v1/variations/edit-link
POST
/v1/variations/edit-link/validate
POST
/v1/websites/verify-script
POST
/v1/mobile/grants
GET
/v1/mobile/workspaces/{workspaceKey}/config
POST
/v1/mobile/events
POST
/v1/mobile/preview/pair

Authentication

Section titled “Authentication”

secretKeyBearer

Section titled “secretKeyBearer”

Your workspace secret key in the Authorization header. Server to server only: never put it in a browser, a mobile app or a public repository. The key decides the workspace.

Security scheme type: http

Bearer format: grona_sk_<keyId>_<secret>

secretKeyHeader

Section titled “secretKeyHeader”

The same workspace secret key, sent in the X-API-Key header instead of Authorization.

Security scheme type: apiKey

Header parameter name: X-API-Key