kantinesms

1. Introduksjon

Velkommen til dokumentasjonen for å bruke kantinesms. For å få tilgang, ta kontakt med oyvind@host1.no. Nedenfor her står det informasjon på hvordan du bruker systemet.

1.1. Hvordan autentisere seg?

Du må sende ved en header som kaller seg Kantinesms-Token. Denne token inneholder en nøkkel opp til 62 tegn. Hver token har en rettighet til å legge til og/eller hente informasjon.

1.2. Manglende rettighet

En token kan ha enten rettigheter til POST eller GET, eller begge to. Et eksempel på feilmelding som kommer frem ved manglende rettighet: 
{
"error": true,
"message": "You do not have permissions for PUSH"
}

1.3. Feilmelding

Hver forespørsel kan returnere med en feilmelding. 
{
"error": true,
"message": "reason for error"
}

1.4. Suksess

Hver POST-forespørsel returnerer en success, men GET returnerer objekt eller generell data. 
{
"success": true,
"message": "reason for success"
}

2. Legge til meny

NB: Krever rettighet PUSH eller PUSHPULL.
Forespørsel
Method: POST - Endpoint: /push 
{
"passed_message": "Varm baguett med ost og skinke"
}
Respons
{
"success": true,
"message": "Successfully pushed message"
}

3. Hente siste meny

NB: Krever rettighet PULL eller PUSHPULL.
Forespørsel
Method: GET - Endpoint: /pull/today
Respons
{
    "entry": "2",
    "date": "2018-02-13",
    "published": {
        "raw": "1518526960",
        "formatted": "2018-02-13 13:02:40",
        "format": "Y-m-d H:i:s"
    },
    "menu": "Varm baguett med ost og skinke"
}

3.1. Hente meny basert på ID

NB: Krever rettighet PULL eller PUSHPULL.
Forespørsel
Method: GET - Endpoint: /pull/entry/2
Respons
{
    "entry": "2",
    "date": "2018-02-13",
    "published": {
        "raw": "1518526960",
        "formatted": "2018-02-13 13:02:40",
        "format": "Y-m-d H:i:s"
    },
    "menu": "Varm baguett med ost og skinke"
}

3.1. Hente meny basert på dato

NB: Krever rettighet PULL eller PUSHPULL.
Forespørsel
Method: GET - Endpoint: /pull/date/13-02-2018
Respons
[
    {
        "entry": "2",
        "date": "2018-02-13",
        "published": {
            "raw": "1518526960",
            "formatted": "2018-02-13 13:02:40",
            "format": "Y-m-d H:i:s"
        },
        "menu": "Varm baguett med ost og skinke"
    },
    {
        "entry": "1",
        "date": "2018-02-13",
        "published": {
            "raw": "1518526913",
            "formatted": "2018-02-13 13:01:53",
            "format": "Y-m-d H:i:s"
        },
        "menu": "Varm baguett med ost og skinke, pluss tomat og agurk"
    }
]
© Copyleft Solutions 2024