There's only 1 endpoint: /api/v1/articles
.
It accepts POST
and GET
requests, and requires an apiKey
parameter set in the URL query.
The request body should be sent as JSON, with the proper Content-Type: application/json
header.
For GET
:
It will return an array of the current saved URLs for your next Daily Digest (which can be added via the API or automatically as new feed items are found).
Here's an example request:
curl "https://bloginmail.com/api/v1/articles?apiKey=fake-api-key"
And an example response:
[
{
"url": "https://bloginmail.com",
"title": "BlogInMail. Get your blogs in your email, daily."
},
{
"url": "https://stories.onbrn.com",
"title": "Stories by Bruno Bernardino"
}
]
For POST
:
It adds a new Saved URL to your next Daily Digest.
It will return a simple {"code": 0, "message": "description"}
if all goes well, otherwise it'll show you an error.
It requires a url
parameter, and will accept a title
as well (otherwise it will default to the url
).
Here's an example request:
curl -X "POST" "https://bloginmail.com/api/v1/articles?apiKey=fake-api-key" \
-H 'Content-Type: application/json' \
-d $'{
"url": "https://bloginmail.com",
"title": "BlogInMail. Get your blogs in your email, daily."
}'
And an example response:
{
"code": 0,
"message": "Article added"
}
For errors:
It will return a simple {"code": number, "message": "description"}
and the appropriate HTTP Status code (401
on bad/missing API Key and 400
on missing required field).