Appearance
Website API
The SaaS edition's public website (installation administrators) — its own pages in every language and its search settings.
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
| Method | Path | What it does |
|---|---|---|
| GET | /site-pages/files | The latest pictures and documents uploaded for the website's pages (administrators; 100) |
| POST | /site-pages/files | Uploads a picture or a document for the website's pages (administrators) |
| GET | /site-pages | Every website page with its title in the default language and its languages |
| POST | /site-pages | Creates a website page |
| POST | /site-pages/starters | Adds the starter legal pages that don't exist yet (terms, privacy, refunds, cookies) as drafts |
| POST | /site-pages/preview | A body as the website shows it (cleaned HTML; Markdown converted) |
| GET | /site-pages/{page} | One website page with every language's text |
| PUT | /site-pages/{page} | Changes a website page |
| DELETE | /site-pages/{page} | Deletes a website page (every language) |
| GET | /site/seo | The website's search and sharing settings |
| PUT | /site/seo | Saves search and sharing settings (fields left out keep their value) |
| POST | /site/seo/image | Uploads the sharing picture (made 1200 × 630 JPEG) |
| DELETE | /site/seo/image | Removes the sharing picture |
GET /site-pages/files
The latest pictures and documents uploaded for the website's pages (administrators; 100)
Responses
- 200 — url, name (original), kind (image or document), mime, size of each.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X GET "https://your-site.com/api/v1/site-pages/files" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /site-pages/files
Uploads a picture or a document for the website's pages (administrators)
Pictures (PNG, JPEG, GIF, WebP up to 10 MB) are drawn again, at most 2400 px wide; documents (PDF, Word, Excel, PowerPoint, OpenDocument, TXT, CSV, ZIP up to 20 MB) are kept as uploaded. Served at the answered url: pictures and PDFs in the browser, other documents as downloads.
Request body
multipart/form-data
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | yes | |
kind | string | One of: image, document. |
Responses
- 201 — The file: url, name, kind, mime, size.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/site-pages/files" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-F "file=…" \
-F "kind=…"GET /site-pages
Every website page with its title in the default language and its languages
Responses
- 200 — Pages; meta.locales and meta.default_locale.
- 403 — Not an installation administrator, or not a full-access token.
bash
curl -X GET "https://your-site.com/api/v1/site-pages" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /site-pages
Creates a website page
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | yes | Not an address the app uses. At most 80 characters. Pattern ^[a-z0-9]+(?:-[a-z0-9]+)*$. |
status | string | One of: draft, published. | |
menu | string | One of: none, header, footer. | |
position | integer | Minimum 0. Maximum 9999. | |
noindex | boolean | ||
translations | object | yes | Language code => text; the default language is required, languages left out are removed. |
Responses
- 201 — Created.
- 403 — Not an installation administrator, or not a full-access token.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.slug | string | ||
data.status | string | One of: draft, published. | |
data.menu | string | One of: none, header, footer. | |
data.position | integer | ||
data.noindex | boolean | ||
data.url | string | ||
data.published_at | string, nullable | ||
data.updated_at | string, nullable | ||
data.translations | object |
bash
curl -X POST "https://your-site.com/api/v1/site-pages" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"slug":"text","status":"draft","menu":"none","position":0,"noindex":true,"translations":{}}'POST /site-pages/starters
Adds the starter legal pages that don't exist yet (terms, privacy, refunds, cookies) as drafts
Written in the default language, filled with config pages.* (company, country, contact email, refund days); unset details stay as [placeholders].
Responses
- 201 — data.added: the addresses added.
- 403 — Not an installation administrator.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.added | string[] |
bash
curl -X POST "https://your-site.com/api/v1/site-pages/starters" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /site-pages/preview
A body as the website shows it (cleaned HTML; Markdown converted)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
format | string | yes | One of: html, markdown. |
body | string, nullable |
Responses
- 200 — data.html
- 403 — Not an installation administrator.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.html | string |
bash
curl -X POST "https://your-site.com/api/v1/site-pages/preview" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"format":"html","body":"text"}'GET /site-pages/{page}
One website page with every language's text
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | path | integer | yes |
Responses
- 200 — OK
- 403 — Not an installation administrator.
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.slug | string | ||
data.status | string | One of: draft, published. | |
data.menu | string | One of: none, header, footer. | |
data.position | integer | ||
data.noindex | boolean | ||
data.url | string | ||
data.published_at | string, nullable | ||
data.updated_at | string, nullable | ||
data.translations | object |
bash
curl -X GET "https://your-site.com/api/v1/site-pages/{page}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /site-pages/{page}
Changes a website page
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | yes | Not an address the app uses. At most 80 characters. Pattern ^[a-z0-9]+(?:-[a-z0-9]+)*$. |
status | string | One of: draft, published. | |
menu | string | One of: none, header, footer. | |
position | integer | Minimum 0. Maximum 9999. | |
noindex | boolean | ||
translations | object | yes | Language code => text; the default language is required, languages left out are removed. |
Responses
- 200 — OK
- 403 — Not an installation administrator.
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.slug | string | ||
data.status | string | One of: draft, published. | |
data.menu | string | One of: none, header, footer. | |
data.position | integer | ||
data.noindex | boolean | ||
data.url | string | ||
data.published_at | string, nullable | ||
data.updated_at | string, nullable | ||
data.translations | object |
bash
curl -X PUT "https://your-site.com/api/v1/site-pages/{page}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"slug":"text","status":"draft","menu":"none","position":0,"noindex":true,"translations":{}}'DELETE /site-pages/{page}
Deletes a website page (every language)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | path | integer | yes |
Responses
- 204 — Deleted.
- 403 — Not an installation administrator.
- 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/site-pages/{page}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /site/seo
The website's search and sharing settings
Responses
- 200 — OK
- 403 — Not an installation administrator.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.title | string | ||
data.description | string | ||
data.keywords | string | ||
data.twitter | string | ||
data.google_verification | string | ||
data.bing_verification | string | ||
data.noindex | boolean | ||
data.consent | boolean | ||
data.head_code | string | ||
data.body_code | string | ||
data.og_image | string, nullable |
bash
curl -X GET "https://your-site.com/api/v1/site/seo" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /site/seo
Saves search and sharing settings (fields left out keep their value)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
title | string | At most 70 characters. | |
description | string | At most 300 characters. | |
keywords | string | At most 300 characters. | |
twitter | string | At most 30 characters. | |
google_verification | string | At most 100 characters. | |
bing_verification | string | At most 100 characters. | |
noindex | boolean | ||
consent | boolean | Ask visitors (cookie banner) before the custom code loads; default true. | |
head_code | string | At most 20000 characters. | |
body_code | string | At most 20000 characters. |
Responses
- 200 — OK
- 403 — Not an installation administrator.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.title | string | ||
data.description | string | ||
data.keywords | string | ||
data.twitter | string | ||
data.google_verification | string | ||
data.bing_verification | string | ||
data.noindex | boolean | ||
data.consent | boolean | ||
data.head_code | string | ||
data.body_code | string | ||
data.og_image | string, nullable |
bash
curl -X PUT "https://your-site.com/api/v1/site/seo" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"title":"text","description":"text","keywords":"text","twitter":"text","google_verification":"text","bing_verification":"text","noindex":true,"consent":true,"head_code":"text","body_code":"text"}'POST /site/seo/image
Uploads the sharing picture (made 1200 × 630 JPEG)
Request body
multipart/form-data, required
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | yes |
Responses
- 200 — OK
- 403 — Not an installation administrator.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.title | string | ||
data.description | string | ||
data.keywords | string | ||
data.twitter | string | ||
data.google_verification | string | ||
data.bing_verification | string | ||
data.noindex | boolean | ||
data.consent | boolean | ||
data.head_code | string | ||
data.body_code | string | ||
data.og_image | string, nullable |
bash
curl -X POST "https://your-site.com/api/v1/site/seo/image" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-F "file=…"DELETE /site/seo/image
Removes the sharing picture
Responses
- 200 — OK
- 403 — Not an installation administrator.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.title | string | ||
data.description | string | ||
data.keywords | string | ||
data.twitter | string | ||
data.google_verification | string | ||
data.bing_verification | string | ||
data.noindex | boolean | ||
data.consent | boolean | ||
data.head_code | string | ||
data.body_code | string | ||
data.og_image | string, nullable |
bash
curl -X DELETE "https://your-site.com/api/v1/site/seo/image" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"