Comunic/ComunicAPI
1
0
Fork 0
mirror of https://github.com/pierre42100/ComunicAPI synced 2024-12-25 13:08:58 +00:00
Code Issues Projects Releases Wiki Activity
450 Commits 1 Branch 6 Tags 558 KiB
PHP 99.9%
f99e16c23e
Go to file
Pierre HUBERT f99e16c23e Updated README
2019-01-26 08:22:15 +01:00
3rdparty Implemented RestServer controller 2017-05-17 14:05:23 +02:00
bin Can create clients from shell 2018-05-07 18:50:50 +02:00
classes Updated term to better meaning 2019-01-25 19:16:57 +01:00
config Can get calls configuration 2019-01-22 17:39:45 +01:00
functions Added incognito mode 2019-01-11 12:03:59 +01:00
helpers Setup API requests limit system. 2018-08-20 13:45:50 +02:00
RestControllers Can hang up calls 2019-01-26 08:01:18 +01:00
tests/classes/models Can tests for BaseUniqueObject 2018-07-12 14:10:41 +02:00
.gitignore Can easily overwrite website configuration 2018-05-07 18:59:15 +02:00
.htaccess Connexion to database 2017-05-17 14:01:36 +02:00
db_struct.sql Updated term to better meaning 2019-01-25 19:16:57 +01:00
index.php Setup API requests limit system. 2018-08-20 13:45:50 +02:00
init.php Can easily overwrite website configuration 2018-05-07 18:59:15 +02:00
LICENSE Added license 2017-05-17 13:49:02 +02:00
README.md Updated README 2019-01-26 08:22:15 +01:00

README.md

The Comunic API

This project is the main Comunic RestAPI. It assures data backend support.

(c) Pierre HUBERT since 2017

Crons required for Comunic

Currently, this server does not make use of crons.

Use calls in Comunic

To use calls in Comunic, you need a WebRTCSignalExchangerServer, a small signal exchanging server written using NodeJS. You also need to modify your configuration file located at config/overwrite.php by copying and pasting commented configuration located at config/calls.php and make it fit your needs.

Add API clients

In order to easily add clients to the API, a script has been created. bin/add_client [name] [token] Note : The name of the client must be unique, and the token should the strongest as possible