README

README

@@ -0,0 +1,39 @@
+VDM webservice API for 3ie recruitment.
+
+API online demo:
+  https://api.vdm.rthoni.com/
+  Api-Key: demo42
+
+API Documentation:
+  - https://api.vdm.rthoni.com/doc/index.html
+  - http://vdm.3ie.fr/doc/index.html
+
+Developped with:
+  - apache2
+      modules:
+      - ssl (optionnal)
+      - rewrite
+  - PHP 5.3.3-7+squeeze19
+  - mysql  Ver 14.14 Distrib 5.1.73
+
+Apache configuration example:
+  misc/api.vdm
+
+API configuration example:
+  misc/config.php.sample
+  Save it as misc/config.php
+
+Database structure:
+  misc/create_database.sql
+  Create database, then insert this structure
+
+API test:
+  Create structure then fill database with test_database.sql
+  Exec misc/tests.php
+
+Clear script:
+  misc/api.vdm-clear.php
+  Remove expired tokens
+  Run it frequenlty (every 24h would be nice)
+  Cron example:
+    misc/api.vdm-cron