Commit 0bc381bb authored by bmortier's avatar bmortier

🚑 fix(api) Document the rest api

Make the text more like in 1.4
Added note that the api will be deprecated with 1.4 REST API
Signed-off-by: bmortier's avatarBenoit Mortier <benoit.mortier@opensides.be>
parent 019e69d8
Fusiondirectory WebService
==========================
FusionDirectory WebService plugin exposes a JSONRPC webservice you can use if you want to access LDAP content through FusionDirectory system.
This way, you ensure that things like foreign keys are kept consistent, and you have a nicer API than the low-level LDAP one.
FusionDirectory WebService plugin exposes a JSON RPC webservice that you can use if you want to access LDAP content through FusionDirectory system.
This way, you ensure that your ldap objects are kept consistent, your are able to use the system templates and have restrictions applied by acls.
It is a standard JSONRPC server served on HTTPS protocol.
On top of that you have a nicer API than the low-level LDAP one.
Note that you can allow HTTP in plugin configuration, but please avoid doing so except for testing purposes.
The `JSON RPC webservice methods are detailed here <http://api.fusiondirectory.org/classfdRPCService.html#details>`_.
The `webservice methods are detailed here <http://api.fusiondirectory.org/classfdRPCService.html#details>`_.
.. warning::
This API is deprecated in favour of the REST API coming in FusionDirectory 1.4.
So i will not evolve apart from eventual bugfixes
.. warning::
Note that you can allow HTTP in plugin configuration, but please avoid doing this except for testing purposes.
Basically you first need to call **login** to get a session ticket you’ll use in the other method calls you make.
If you have several LDAP configured you might call **listLdaps** first to list them and specify which one to use as first parameter of **login** (otherwise just pass NULL as first parameter).
......@@ -16,7 +23,6 @@ If you have several LDAP configured you might call **listLdaps** first to list t
Then you can use **ls** to list objects of a given type (list types with **listTypes** first if needed).
**getfields** method will give you the fields of a given type (and tab) and **setfields** will allow you to change the value of these fields.
.. code-block:: php
<?php
......@@ -84,4 +90,3 @@ Then you can use **ls** to list objects of a given type (list types with **listT
} catch (jsonRPCClient_NetworkErrorException $e) {
die($e->getMessage());
}
......@@ -59,9 +59,9 @@ author = u'Benoit Mortier Côme Chilliet'
# built documents.
#
# The short X.Y version.
version = u'1.2'
version = u'1.3'
# The full version, including alpha/beta/rc tags.
release = u'1.2'
release = u'1.3'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment