Differences

This shows you the differences between two versions of the page.

--- api [2017/09/19 17:38] – [More documentation] lucy
+++ api [2022/01/11 09:17] – [Detailed Documentation] lucysecurity
@@ Line 1: / Line 1: @@
 ===== LUCY REST API - Background Info =====
-Lucy API is a RESTful web service. The API does not keep the client's state and all requests can be performed in any order.
+Lucy API is a RESTful web service. The API does not keep the client's state and all requests can be performed in any order. Within LUCY the API can be activated under settings/API. You will need to specify the remote IP(s) which is allowed to communicate with the API.
+{{ api1.png?600 }}
 ===== Requirements =====
@@ Line 31: / Line 33: @@
 ===== Example Usage =====
+**WARNING!**
+It's recommended to use "//limit//" GET parameter to specify the max number of entries to get.\\
+This might help to avoid situations when the amount of data would not be comprehensible by the system.\\
+Example:\\
+  {GET /api/campaigns?sort=-created_at&offset=10&limit=10}
 First you need to auth:
@@ Line 73: / Line 81: @@
   {"recipient":{"email":"oliver@test.com","phone":null,"name":"Oliver   Test","staff_type":null,"location":null,"division":null,"comment":null,"link":null,"language_id":null,"recipient_group_id":262,"id":"158928","last_tested":null,"links":[{"rel":"self","href":"/api/recipients/158928"},  {"rel":"recipient_group","href":"/api/recipient-groups/262"}]}}
+===== API End Points =====
+The complete list of API End Points supported by LUCY can be found [[api_end_points|here]]
 ===== Detailed Documentation =====
-A more detailed documentation can be found {{::lucy-rest-api-v3.7.pdf|here}}.
+The detailed documentation for LUCY REST API is available from within the LUCY web interface in the section Settings > API Whitelist > API Documentation.
+{{ api_documentation.png?600 }}
+There's also PDF documentation (for v.4.8.3) can be found {{::lucy_rest_api_documentation.pdf|here}}.