Quickstart – din första upplåsning

Målet: låsa upp en testenhet i STAGE med tre anrop. Bas-URL (STAGE): `https://staging.zesec.com/api`

Förutsättningar#

• Ett STAGE-API-konto ({{phoneNumber}} + {{password}}). Har du inget? Se Få access och Från sandbox till produktion.
• En testenhet som ert konto har nyckel till.
• cURL, Swagger-UI eller Postman.

1. Logga in#

POST /api/auth/login-by-phone med telefonnummer och lösenord. Du får en access-token (JWT) och en refresh-token.

curl -X POST https://staging.zesec.com/api/auth/login-by-phone \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber": "{{phoneNumber}}", "password": "{{password}}"}'

{
  "AccessToken": "<AccessToken>",
  "RefreshToken": "<RefreshToken>"
}

Spara båda. Access-token används i Authorization-headern; refresh-token används för att förnya paret — se Autentisering & tokens.

2. Hämta dina enheter#

GET /api/user/device returnerar de enheter kontot har access till. Fältet id är det {deviceId} du behöver i steg 3.

curl https://staging.zesec.com/api/user/device \
  -H "Authorization: Bearer <AccessToken>"

[
  {
    "id": 1001,
    "name": "Door A",
    "locationId": 42,
    "locationName": "Location 1",
    "companyName": "Example Inc.",
    "doorType": "Entrance",
    "online": true
  },
  {
    "id": 1002,
    "name": "Door B",
    "locationId": 42,
    "locationName": "Location 1",
    "companyName": "Example Inc.",
    "doorType": "Garage",
    "online": true
  }
]

3. Lås upp#

PUT /api/device/{deviceId}/unlock med access-token i headern. Enheten tar emot kommandot och öppnar dörren.

curl -X PUT https://staging.zesec.com/api/device/{deviceId}/unlock \
  -H "Authorization: Bearer <AccessToken>"

200 OK — kommandot är accepterat och vidarebefordrat till enheten.

Samma flöde i Swagger#

1. Öppna API-referensen — den renderas direkt ur /openapi.json.
2. Välj servern STAGE i serverväljaren.
3. Kör POST /api/auth/login-by-phone med {{phoneNumber}} och {{password}}. Kopiera AccessToken ur svaret.
4. Klicka Authorize och klistra in Bearer <AccessToken>.
5. Kör GET /api/user/device och notera id för testdörren.
6. Kör PUT /api/device/{deviceId}/unlock med det id:t.

Samma flöde i Postman#

Ladda ner KiiOn-samlingen för Postman och importera den (Import → File). Samlingen innehåller de fyra anropen och en miljö med variablerna nedan.

1. Sätt BASE_URL till https://staging.zesec.com/api.
2. Sätt phoneNumber och password till era STAGE-uppgifter.
3. Kör 1. Login by phone — testskriptet sparar AccessToken och RefreshToken som samlingsvariabler automatiskt.
4. Kör 2. List devices och sätt deviceId till id för testdörren.
5. Kör 3. Unlock device.

Nästa steg#