No Description

Simon Vieille d64f5ad1cd Merge branch 'release/v1.0.0' 1 month ago
bin ceafee41ec Init of propel for SMS database 1 month ago
etc a64f035acc User example 1 month ago
src a7c56f3c61 Moving routes and functions to controller 1 month ago
var 32f43c74e5 Git ignore for propel 1 month ago
web a7c56f3c61 Moving routes and functions to controller 1 month ago
.gitignore 9dccf0fffb SMS API 1 month ago
Makefile 1faaff727a Makefile tasks 1 month ago
README.md 3e404d61df Documentation 1 month ago
composer.json ceafee41ec Init of propel for SMS database 1 month ago
propel-dist.yaml ceafee41ec Init of propel for SMS database 1 month 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
    },
    ...
]