newsletter-site

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-newsletter-site"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/785a90d6-d113-4561-a162-0888b290dff1/social-card.svg?v=3e7ae33eec8b" alt="newsletter-site" width="600" height="315"></a>
GEThttps://hermeticor.com/p/n/{ref}

Publication home: featured and latest posts

Parameters

refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/archive

Archive with search and pagination

Parameters

qstringquery
pageintegerquery
= 1
rtstringquery
refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/archive"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/s/{slug}

Posts of one section

Parameters

qstringquery
pageintegerquery
= 1
rtstringquery
refstringpathrequired
slugstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/s/{slug}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/a/{slug}

Posts of one author

Parameters

qstringquery
pageintegerquery
= 1
rtstringquery
refstringpathrequired
slugstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/a/{slug}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/about

About page

Parameters

refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/about"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/subscribe

Subscribe page

Parameters

fromstringquery
refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/subscribe"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

POSThttps://hermeticor.com/p/n/{ref}/subscribe

Subscribe (consent recorded with the exact text shown)

Parameters

refstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/p/n/{ref}/subscribe" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/p/{slug}

One post (full text for entitled readers, preview and an upgrade box otherwise)

Parameters

rtstringquery
utm_sourcestringquery
refstringpathrequired
slugstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/p/{slug}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

POSThttps://hermeticor.com/p/n/{ref}/p/{slug}/beacon

Read-depth and time beacon from the post page

Parameters

refstringpathrequired
slugstringpathrequired

Request body

application/json
viewstring
secondsinteger
= 0
depthinteger
= 0
sectionstring
{
  "view": "string",
  "seconds": 0,
  "depth": 0,
  "section": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/p/n/{ref}/p/{slug}/beacon" \
  -H "Content-Type: application/json" \
  -d '{"view":"string","seconds":0,"depth":0,"section":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/feed.xml

RSS feed (free part of every post)

Parameters

refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/feed.xml"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/atom.xml

Atom feed

Parameters

refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/atom.xml"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/sitemap.xml

sitemap.xml

Parameters

refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/sitemap.xml"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/robots.txt

robots.txt

Parameters

refstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/robots.txt"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

GEThttps://hermeticor.com/p/n/{ref}/{*}

301/302 for an old address, else 404

Parameters

refstringpathrequired
*stringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/n/{ref}/{*}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /p/n/{ref}

5XX Default Response

Same as 4XX · GET /p/n/{ref}

Updated