No Description
Simon Vieille d64f5ad1cd Merge branch 'release/v1.0.0' 11 months ago
bin Init of propel for SMS database 11 months ago
etc/security User example 11 months ago
src/App Moving routes and functions to controller 11 months ago
var Git ignore for propel 11 months ago
web Moving routes and functions to controller 11 months ago
.gitignore SMS API 11 months ago
Makefile Makefile tasks 11 months ago
README.md Documentation 11 months ago
composer.json Init of propel for SMS database 11 months ago
propel-dist.yaml Init of propel for SMS database 11 months ago

README.md

Automate Android API

Installation

$ git clone https://gitnet.fr/deblan/android-automate-api.git
$ cd android-automate-api
$ make
$ cp propel-dist.yaml propel.yaml # Edit propel.yaml
$ cp etc/security/users.json-dist etc/security/users.json # Edit users.json
$ make propel

API

HTTP Response status

  • 200: Resource found
  • 201: Resource created
  • 204: Resource removed
  • 404: Resource not found
  • 500: Internal error

When a resource is created or deleted, the response will be like:

{
    "status": true|false,
    "code": 200|201|204|404|500,
    "message": "A message"
}

Create a SMS

POST /api/sms/create with MIME media type application/json

Body

{"sender": "+33611223344", "message": "Hello, World!", "time": "1516031177"}

Delete a SMS

DELETE /api/sms/delete/{id}

Get all SMS

GET /api/sms/list

The response contains an collection of SMS:

[
    {
        "id": 1234,
        "sender": "+33611223344",
        "message": "Hello, World!",
        "received_at": 1516031177,
        "notified_at": 1516031179
    },
    ...
]