yufu
/
manifest
6
2
Fork 0
Code Issues 21 Pull Requests 1 Packages Projects 4 Releases Wiki Activity
manifest/web/modules/custom/etherpad_api
History
Jurij Podgoršek f775e7131f Popravki, dokumentiranje 2024-01-23 22:37:16 +01:00
..
config/schema WIP etherpad integracija 2023-12-08 13:18:38 +01:00
doc Dokumentacija etherpad APIja, popravki, preurejen obrazec za urejanje 2023-12-16 01:53:05 +01:00
src Popravki, dokumentiranje 2024-01-23 22:37:16 +01:00
README.md Dokumentacija etherpad APIja, popravki, preurejen obrazec za urejanje 2023-12-16 01:53:05 +01:00
etherpad_api.info.yml WIP etherpad integracija 2023-12-08 13:18:38 +01:00
etherpad_api.install Service za ether API, izboljsave nastavitev, validacija, manjsi popravek obrazca za dodajanje 2023-12-08 13:20:07 +01:00
etherpad_api.links.menu.yml WIP etherpad integracija 2023-12-08 13:18:38 +01:00
etherpad_api.routing.yml Popravljeno ime routa 2024-01-23 21:52:37 +01:00
etherpad_api.services.yml Service za ether API, izboljsave nastavitev, validacija, manjsi popravek obrazca za dodajanje 2023-12-08 13:20:07 +01:00

README.md

Etherpad API

This module can be used to proxy requests to an etherpad API. After installing the module, you must set the etherpad instance API URL and the API key.

Etherpad API documentation can be found here: https://etherpad.org/doc/v1.8.4/#index_http_api

The etherpad API proxy URL is /etherpad-api (@TODO make configurable). When calling it, you can omit the version part (e.g. /1) and the API key (which is set in the configuration). The pad ID prefix is hardcoded for the moment (so that requests are limited to specific pads, not the whole instance).

Some example API calls can found in api.rest.

You can do either GET or POST requests to the proxy, passing parameters via query or post parameters. POST parameters must be passed as key-value pairs (application/x-www-form-urlencoded). The proxy always makes POST requests to etherpad, for the sake of simplicity. The API key is always added, the padID is always prefixed.

TODO