Card-uri RFID
Endpoint pentru crearea sau modificarea codului de card RFID al unui contact (angajat) în platforma ssm.ro.
Endpoint-ul pentru carduri RFID permite setarea codului de card de acces pentru un contact existent, identificat după marca. Operația este de tip upsert: dacă contactul nu are încă un card RFID, acesta este creat; dacă are deja unul, codul existent este înlocuit cu cel trimis.
Operația necesită ca aplicația Acces Card-uri RFID să fie activată pentru organizație.
Creare sau modificare card RFID
POST /v1/contacts/rfidSetează codul cardului RFID pentru un contact existent, identificat după marca:
- dacă contactul nu are card RFID, se creează unul cu codul trimis;
- dacă contactul are deja un card RFID, codul acestuia este modificat cu valoarea trimisă.
Ce NU modifică această operație
Apelul afectează exclusiv codul RFID. Nu modifică:
- statusul cardului (activ / inactiv);
- statusul de blocat ca urmare a prea multor încercări greșite;
- PIN-ul asociat cardului.
Aceste operațiuni se efectuează din dashboard, din aplicația Acces Card-uri RFID.
Parametri
| Parametru | În | Tip | Obligatoriu | Descriere |
|---|---|---|---|---|
organizatie | body | string | Da | Subdomeniul organizației (ex: demo-organization) |
marca | body | string | Da | Marca contactului căruia i se asociază cardul |
codRFID | body | string | Da | Codul cardului RFID |
Exemplu cerere
{
"organizatie": "demo-organization",
"marca": "M00212",
"codRFID": "0006627031"
}Răspuns
În caz de succes, endpoint-ul returnează 204 No Content (fără corp).
În caz de eroare, răspunsul este un obiect JSON de forma:
{
"error": "Contactul cu marca M00212 nu a fost gasit"
}| Cod | Descriere |
|---|---|
204 No Content | Codul RFID a fost creat sau modificat pentru contact (și, dacă era necesar, s-a creat contul local) |
400 Bad Request | Organizația nu este setată sau este invalidă |
401 Unauthorized | Token de autentificare lipsă sau invalid |
404 Not Found | Această versiune de API nu este disponibilă pe instalarea clientului (endpoint inexistent) |
422 Unprocessable Entity | Eroare de validare — vezi mesajul din răspuns |
500 Server Error | Eroare internă server |
Disponibilitate pe instalări mai vechi
Funcția este disponibilă doar începând cu versiunea care include endpoint-ul
/v1/contacts/rfid. Pe instalările mai vechi, ruta nu există și serverul răspunde
cu 404 Not Found — semn că versiunea API nu este disponibilă pe acea instalare.
În acest caz, corpul răspunsului poate fi HTML/text (nu obiectul JSON uzual), așa
că verificați codul de status HTTP (404), nu conținutul răspunsului.
Mesaje posibile pentru 422 Unprocessable Entity
| Mesaj | Cauză |
|---|---|
Lipsa cod RFID | Parametrul codRFID lipsește sau este gol |
Contactul cu marca {marca} nu a fost gasit | Nu există niciun contact cu marca trimisă |
Aplicatia RFID nu este activata | Aplicația Acces Card-uri RFID nu este activată pentru organizație |
Contul nu este de tip local | Contactul are deja un cont real (non-local) conectat |
Contactul are rol de utilizator! | Contactul are rol de utilizator |