LYNX GROUP SARL Documentation

Postman collection →

Introduction

Base URL: https://backend.lynx-group.org/

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Endpoints

POST

https://backend.lynx-group.org

/api/user/login

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

username

string

required

Example:

quaerat

password

string

required

Example:

inventore

Headers

Body

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/user/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"quaerat\",
    \"password\": \"inventore\"
}"

logout

POST

https://backend.lynx-group.org

/api/user/logout

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/user/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Add Admin.

POST

https://backend.lynx-group.org

/api/admin/new

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 100 characters.

Example:

vylmgezcpswihpikaqeshioen

string

required

Must be a valid email address.

Example:

donnelly.effie@example.com

Auth

Bearer

Headers

Body

{ "name": "vylmgezcpswihpikaqeshioen", "email": "donnelly.effie@example.com" }

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/new" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vylmgezcpswihpikaqeshioen\",
    \"email\": \"donnelly.effie@example.com\"
}"

Admin list.

GET

https://backend.lynx-group.org

/api/admin/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/list could not be found."
}

Alarm Interval.

POST

https://backend.lynx-group.org

/api/admin/alarm-interval

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

occurs_every

number

required

Must not be greater than 60.

Example:

Auth

Bearer

Headers

Body

{ "occurs_every": 15 }

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/alarm-interval" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"occurs_every\": 15
}"

Get Alarm Interval.

GET

https://backend.lynx-group.org

/api/admin/alarm-interval

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/alarm-interval" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/alarm-interval could not be found."
}

Change password

POST

https://backend.lynx-group.org

/api/admin/change-password

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

old_password

string

required

Must be at least 8 characters.

Example:

gfvnhtyjc

password

string

required

Example:

tempore

Auth

Bearer

Headers

Body

{ "old_password": "gfvnhtyjc", "password": "tempore" }

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/change-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"gfvnhtyjc\",
    \"password\": \"tempore\"
}"

Store a newly agent.

POST

https://backend.lynx-group.org

/api/admin/agent/new

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

first_name

string

required

Example:

odio

last_name

string

required

Example:

quo

birth_certificate

file

required

Must be a file. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpIWkJGu

avatar

file

required

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpj4kOoN

adresse

string

required

Example:

est

phone

string

required

Example:

sit

finger_print_data

string

Example:

molestiae

string

required

Example:

flossie65@example.net

birthday

string

required

Must be a valid date. Must be a date before today.

Example:

2020-10-04

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/agent/new" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "first_name=odio"\
    --form "last_name=quo"\
    --form "adresse=est"\
    --form "phone=sit"\
    --form "finger_print_data=molestiae"\
    --form "email=flossie65@example.net"\
    --form "birthday=2020-10-04"\
    --form "birth_certificate=@/tmp/phpIWkJGu" \
    --form "avatar=@/tmp/phpj4kOoN"

Agent list.

GET

https://backend.lynx-group.org

/api/admin/agent/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/agent/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/agent/list could not be found."
}

Store a fingerprint.

POST

https://backend.lynx-group.org

/api/admin/agent/{agent_id}/fingerprint

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

agent_id

string

required

The ID of the agent.

Example:

omnis

Body Parameters

finger_print_data

string

Example:

molestiae

Auth

Bearer

Headers

URL Parameters

Body

{ "finger_print_data": "molestiae" }

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/agent/omnis/fingerprint" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"finger_print_data\": \"molestiae\"
}"

New supervisor.

POST

https://backend.lynx-group.org

/api/admin/supervisor/new

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

birthday

string

required

Must be a valid date. Must be a date before today.

Example:

2016-06-13

birth_certificate

file

required

Must be a file. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpz3plCH

adresse

string

required

Must not be greater than 255 characters.

Example:

mzjjhaewfrcmcsgkldexah

phone

string

required

Must not be greater than 20 characters.

Example:

qotnoc

string

Must be a valid email address.

Example:

kelli58@example.com

avatar

file

required

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpMPKYo0

name

string

required

Must not be greater than 255 characters.

Example:

fbepwybabjemsdivbksbmwmd

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/supervisor/new" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "birthday=2016-06-13"\
    --form "adresse=mzjjhaewfrcmcsgkldexah"\
    --form "phone=qotnoc"\
    --form "email=kelli58@example.com"\
    --form "name=fbepwybabjemsdivbksbmwmd"\
    --form "birth_certificate=@/tmp/phpz3plCH" \
    --form "avatar=@/tmp/phpMPKYo0"

Supervisor list.

GET

https://backend.lynx-group.org

/api/admin/supervisor/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/supervisor/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/supervisor/list could not be found."
}

Attendance list.

GET

https://backend.lynx-group.org

/api/admin/attendance/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/attendance/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/attendance/list could not be found."
}

Controls list.

GET

https://backend.lynx-group.org

/api/admin/control/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/control/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/control/list could not be found."
}

New client

POST

https://backend.lynx-group.org

/api/admin/client/new

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

full_name

string

required

Must not be greater than 255 characters.

Example:

amxrfwydhnx

string

required

Must be a valid email address. Must not be greater than 255 characters.

Example:

ctowne@example.net

phone

string

required

Must not be greater than 20 characters.

Example:

kih

phone_2

string

Must not be greater than 20 characters.

Example:

mevmvullslsddh

adresse

string

required

Must not be greater than 255 characters.

Example:

rgcnt

contract_file

file

required

Must be a file. Must not be greater than 2048 kilobytes.

Example:

/tmp/php4qsFRU

type

string

contract_duration

number

required

Example:

239675303.134

contract_start

string

required

Must be a valid date.

Example:

2024-03-28T15:29:06

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/client/new" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "full_name=amxrfwydhnx"\
    --form "email=ctowne@example.net"\
    --form "phone=kih"\
    --form "phone_2=mevmvullslsddh"\
    --form "adresse=rgcnt"\
    --form "contract_duration=239675303.134"\
    --form "contract_start=2024-03-28T15:29:06"\
    --form "contract_file=@/tmp/php4qsFRU"

New client post

POST

https://backend.lynx-group.org

/api/admin/client/new-post

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

client_id

string

required

Example:

name

string

required

Must not be greater than 255 characters.

Example:

styjk

adresse

string

required

Must not be greater than 255 characters.

Example:

fezjfmbvze

type

string

latitude

string

required

Example:

quis

longitude

string

required

Example:

totam

Auth

Bearer

Headers

Body

{ "client_id": "et", "name": "styjk", "adresse": "fezjfmbvze", "type": null, "latitude": "quis", "longitude": "totam" }

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/client/new-post" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": \"et\",
    \"name\": \"styjk\",
    \"adresse\": \"fezjfmbvze\",
    \"latitude\": \"quis\",
    \"longitude\": \"totam\"
}"

New client base intervention

POST

https://backend.lynx-group.org

/api/admin/client/new-base-intervention

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

agent_ids

string[]

required

Example:

["quia"]

post_id

string

required

Example:

consequuntur

supervisor_id

string

required

Example:

start_time

string

required

Must be a valid date in the format H:i.

Example:

15:29

end_time

string

required

Must be a valid date in the format H:i.

Example:

15:29

day_frequency

number

required

Example:

1454.299360923

Auth

Bearer

Headers

Body

{ "agent_ids": [ "quia" ], "post_id": "consequuntur", "supervisor_id": "et", "start_time": "15:29", "end_time": "15:29", "day_frequency": 1454.299360923 }

Received response

Example request:

curl --request POST \
    "https://backend.lynx-group.org/api/admin/client/new-base-intervention" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"agent_ids\": [
        \"quia\"
    ],
    \"post_id\": \"consequuntur\",
    \"supervisor_id\": \"et\",
    \"start_time\": \"15:29\",
    \"end_time\": \"15:29\",
    \"day_frequency\": 1454.299360923
}"

Client list.

GET

https://backend.lynx-group.org

/api/admin/client/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/list could not be found."
}

Post list.

GET

https://backend.lynx-group.org

/api/admin/client/post-list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/post-list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/post-list could not be found."
}

Post by client.

GET

https://backend.lynx-group.org

/api/admin/client/{client_id}/posts

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

client_id

string

required

The ID of the client.

Example:

unde

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/unde/posts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/unde/posts could not be found."
}

Base intervention list.

GET

https://backend.lynx-group.org

/api/admin/client/base-intervention-list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/base-intervention-list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/base-intervention-list could not be found."
}

Today intervention.

GET

https://backend.lynx-group.org

/api/admin/client/today-intervention

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/today-intervention" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/today-intervention could not be found."
}

Intervention historical.

GET

https://backend.lynx-group.org

/api/admin/client/interventions/historical

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/interventions/historical" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/interventions/historical could not be found."
}

Intervention by date.

GET

https://backend.lynx-group.org

/api/admin/client/intervention-by-date/{date?}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

date

string

Example:

eaque

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/intervention-by-date/eaque" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/intervention-by-date/eaque could not be found."
}

Calender event.

GET

https://backend.lynx-group.org

/api/admin/client/calender-event

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://backend.lynx-group.org/api/admin/client/calender-event" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "The route api/admin/client/calender-event could not be found."
}

LYNX GROUP SARL Documentation

LYNX GROUP SARL Documentation

Introduction

Authenticating requests

Endpoints

POST api/user/login

Headers

Body Parameters

logout

Headers

Add Admin.

Headers

Body Parameters

Admin list.

Headers

Alarm Interval.

Headers

Body Parameters

Get Alarm Interval.

Headers

Change password

Headers

Body Parameters

Store a newly agent.

Headers

Body Parameters

Agent list.

Headers

Store a fingerprint.

Headers

URL Parameters

Body Parameters

New supervisor.

Headers

Body Parameters

Supervisor list.

Headers

Attendance list.

Headers

Controls list.

Headers

New client

Headers

Body Parameters

New client post

Headers

Body Parameters

New client base intervention

Headers

Body Parameters

Client list.

Headers

Post list.

Headers

Post by client.

Headers

URL Parameters

Base intervention list.

Headers

Today intervention.

Headers

Intervention historical.

Headers

Intervention by date.

Headers

URL Parameters

Calender event.

Headers