API docs by Redocly

TerminalAPI (1.0.0)

License: Copyright

Terminal api description.

Liste des erreurs

Voici la liste des codes d'erreur internes, ces erreurs n'apparaissent que dans le cadre d'un statut HTTP 500.

Code Statut HTTP
TER-1 500
TER-4 500
TER-10 500

Voici la liste des codes d'erreur

Code Description Statut HTTP
TER-2 Chemin invalide 404
TER-3 Un paramètre est manquant ou invalide dans le corps de la requête (ex: paramètre envoyé en string au lieu d'un integer) 422
TER-5 Token manquant 401
TER-6 Signature du token invalide 400
TER-7 Token expiré 400
TER-8 Token invalide 400
TER-9 Accès non authorisé au service (token invalide) 403

Initialisation Boostore

Initialise la configuration de caisse pour Boostore.

Authorizations:
BearerToken
Request Body schema: application/json
required

Données nécessaires pour initialiser boostore

deviceId
required
string

Responses

Request samples

Content type
application/json
{
  • "deviceId": "b2d13f51-97f8-4d69-b6fd-1f1d1a22c445"
}

Response samples

Content type
application/json
{
  • "pointOfSaleId": 27,
  • "licenseId": "e545d1e0-f846-4f2d-8d44-3f91443ac103",
  • "deviceId": "b2d13f51-97f8-4d69-b6fd-1f1d1a22c445",
  • "services": {
    },
  • "cashiers": [
    ],
  • "parameters": { },
  • "publicKey": "...",
  • "privateKey": "...",
  • "paxBeneficiary": "TEST-CISS"
}

Supprimer une carte caissier

Supprime une carte caissier spécifique.

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 1

Identifiant de la carte caissier

Responses

Response samples

Content type
application/json
{
  • "message": "Le bearer token invalide",
  • "code": "TER-6"
}

libère une carte caissier

libère une carte caissier spécifique.

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 1

Identifiant de la carte caissier

Responses

Response samples

Content type
application/json
{
  • "message": "Le bearer token invalide",
  • "code": "TER-6"
}

Créer un caissier

Crée un nouveau caissier pour un point de vente donné.

Authorizations:
BearerToken
Request Body schema: application/json
required

Informations du caissier

name
required
string
point_of_sale_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "Cashier test",
  • "point_of_sale_id": 123
}

Response samples

Content type
application/json
{
  • "cashier": { }
}

Récupérer les détails d'un caissier et ses cartes

Récupérer les détails d'un caissier ainsi que les détails des cartes associées à ce caissier

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 5

Identifiant du caissier

Responses

Response samples

Content type
application/json
{
  • "id": 2,
  • "name": "Cashier Test",
  • "pointofsales_id": 5,
  • "cashier_cards": [
    ],
  • "created_at": "2025-02-20T08:21:33.000000Z",
  • "updated_at": "2025-02-20T08:21:33.000000Z",
  • "deleted_at": null
}

Supprimer un caissier

Supprimer un caissier et libérer les cartes associées

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 5

Identifiant du caissier

Responses

Response samples

Content type
application/json
{
  • "message": "Le bearer token invalide",
  • "code": "TER-6"
}

Mettre à jour les détails d'un caissier

Mettre à jour les détails d'un caissier, y compris le nom et l'identifiant du point de vente

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 5

Identifiant du caissier

Request Body schema: application/json
required

Détails du caissier à mettre à jour

name
string
point_of_sale_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "terminalapi_caissier12",
  • "point_of_sale_id": 1
}

Response samples

Content type
application/json
{
  • "id": 1077,
  • "pointofsales_id": 1,
  • "name": "terminalapi_caissier12",
  • "created_at": "2025-02-24T13:03:43.000000Z",
  • "updated_at": "2025-02-25T15:51:42.000000Z",
  • "deleted_at": null,
  • "cashier_cards": [
    ]
}

Assigner une carte à un caissier

Assigner une carte à un caissier donné

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 5

Identifiant du caissier

idCard
required
integer
Example: 1

Identifiant de la carte NFC

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "cashier_id": 5,
  • "pointofsales_id": 1,
  • "nfc_card_number": "12345678",
  • "cashier_cards": [
    ]
}

Lister les caissiers par point de vente

Récupère la liste des caissiers associés à un point de vente donné.

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 5

Identifiant du point de vente

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lister les cartes par point de vente

Récupère la liste des cartes du même groupe, assignées au point de vente donné ou sans point de vente

Authorizations:
BearerToken
path Parameters
idGroup
required
integer
Example: 5

Identifiant du groupe

pointOfSaleId
required
integer
Example: 5

Identifiant du point de vente

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mettre à jour une valeur d’une fonction paramètre

Met à jour la valeur d’une fonction paramètre pour un point de vente spécifique.

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 5

Identifiant du point de vente

functionParameterId
required
integer
Example: 10

Identifiant de fonction_parametre

Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "new_value"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "functions_id": 3,
  • "name": "Cashier Mode",
  • "value_type": "STRING",
  • "value_default": "NONE",
  • "created_at": "2025-02-18T15:22:58.000000Z",
  • "updated_at": "2025-02-27T15:27:12.000000Z",
  • "deleted_at": null,
  • "function_parameter_values": [
    ]
}

Récupérer les valeurs d’un paramètre de fonction

Récupère les valeurs d’un paramètre de fonction pour un point de vente spécifique.

Authorizations:
BearerToken
path Parameters
pointOfSaleId
required
integer
Example: 5

Identifiant du point de vente

id
required
integer
Example: 10

Identifiant de la fonction

Responses

Response samples

Content type
application/json
[
  • {
    }
]