APIs
< How it works | Advanced use
Jump to navigation
Jump to search
| Line 14: | Line 14: | ||
| − | json request | + | json request (POST) |
<syntaxhighlight> | <syntaxhighlight> | ||
| Line 45: | Line 45: | ||
| − | json request | + | json request (POST) |
<syntaxhighlight> | <syntaxhighlight> | ||
| Line 52: | Line 52: | ||
'property': String (semantic property holding the value) | 'property': String (semantic property holding the value) | ||
} | } | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | |||
| + | |||
| + | ==wikipages== | ||
| + | The following endpoint retrieves one or more wiki pages under a specific path. | ||
| + | Options: | ||
| + | |||
| + | |||
| + | endpoint | ||
| + | |||
| + | <syntaxhighlight> | ||
| + | https://culturaitaliana.org/api/wikipages | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | |||
| + | urlencoded request (GET) | ||
| + | |||
| + | <syntaxhighlight> | ||
| + | title: page title, | ||
| + | retrieve_index: Boolean (if multiple pages, return a structured index), | ||
| + | organization_information: Boolean (if the page belongs to an organization, return organization's data) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 15:57, 18 June 2020
sendemail
The following endpoint allows to send an email message, using one of the templates available on the site, to arbitrary lists of recipients including groups of the related mediawiki.
endpoint
https://culturaitaliana.org/api/sendemail
json request (POST)
{
'path': String (url of related wiki),
'username': String (username of bot or admin account),
'password': String (password of bot or admin account),
'template': String (name of used "pug" template),
'to' or Array: String (list of recipients, can include one or more wiki groups),
'cc': String or Array (list of recipients, can include one or more wiki groups),
'bcc': String or Array (list of recipients, can include one or more wiki groups),
'locals': Object (keys to be interpolated with values in the related template),
}
sendcode
The following endpoint sends a pin code at the provided email address held by a given property name.
endpoint
https://culturaitaliana.org/api/sendcode
json request (POST)
{
'email': String (email),
'property': String (semantic property holding the value)
}
wikipages
The following endpoint retrieves one or more wiki pages under a specific path. Options:
endpoint
https://culturaitaliana.org/api/wikipages
urlencoded request (GET)
title: page title,
retrieve_index: Boolean (if multiple pages, return a structured index),
organization_information: Boolean (if the page belongs to an organization, return organization's data)