API-dokumentation
Integrera Passa Personal med kassa, passage, chatt eller egna system – över HTTPS med er egen API-nyckel.
Kom igång
API:t låter era andra system prata med Passa Personal: kassan skickar dagens försäljning, passagesystemet stämplar och chatten får veta när ett ledigt pass läggs ut.
https://er-domän.se/api.phpAPI-nyckel: Inloggad chef hittar ”User-Key / X-Api-Key” under Inställningar → Kassakoppling, Webhooks & REST-API.
Autentisering: Skicka nyckeln i HTTP-huvudet
X-Api-Key: ER_NYCKEL. Huvudet rekommenderas framför nyckel i URL:en.Svaren är alltid JSON. Fel ger HTTP-status och ett error-fält, till exempel 401 vid ogiltig nyckel, 409 vid dubbel incheckning och 422 vid felaktiga fält. POST-anrop ska vara JSON med Content-Type: application/json.
1. Kassakoppling – skicka dagsförsäljning
?a=posAnropas vid dagsavslut/Z-rapport.TruePOS, Sitoo, Shopify, WooCommerce, Northmill Flo, ExtendaGO, PC-Kassa, HiCore, Loomis Pay, Zettle, SumUp, Square, Ancon, Onslip, Caspeco, Trivec och Bambora stöds. De flesta fält är valfria och vanliga namnvarianter känns igen automatiskt.
POST /api.php?a=pos
X-Api-Key: ER_NYCKEL
Content-Type: application/json
{
"sales": [{
"date": "2026-10-17", "amount": 48250.00,
"net_sales": 38600.00, "vat": 9650.00,
"tx_count": 212, "card": 32800, "swish": 11850,
"cash": 1900, "invoice": 1700, "tips": 940,
"z_nr": "Z-1042", "provider": "truepos"
}]
}| Fält | Betydelse |
|---|---|
date | Datum i formatet ÅÅÅÅ-MM-DD. Även z_date, business_date och timestamp accepteras. |
amount | Bruttoförsäljning inklusive moms. Varianter som total, gross_sales och amount_ore hanteras. |
net_sales, vat | Netto och moms. Saknas de beräknas netto från bruttobeloppet. |
card, swish, cash, invoice | Betalningsfördelning och återköp. |
tips | Dagens dricks, som hamnar i drickspoolen. |
hourly, staff_sales | Valfri försäljning per timme eller per anställd. |
Svar: {"ok":true,"saved":1}. Samma datum kan skickas igen – senaste värdet gäller. Utan API kan SIE4- eller CSV-filer importeras i appen under Budget & Kassa.
2. Status – vilka är inne just nu?
?a=api_statusNärvarande personal, raststatus och dagens försäljning.GET /api.php?a=api_status
X-Api-Key: ER_NYCKEL
{
"org_id": 3, "site": "Kvarterskrogen",
"company": "Exempel AB",
"present": [{"staff_id": 12, "name": "Anna Andersson",
"role": "Servis", "since": 1760713200000, "on_break": false}],
"sales_today": 48250.0, "timestamp": 1760734800000
}since och timestamp är millisekunder sedan epoch (UTC). Samma närvarodata driver närvarotavlan för vägg/TV.
3. Stämpling via API
?a=api_punchChecka in eller ut personal från ett externt system.POST /api.php?a=api_punch
X-Api-Key: ER_NYCKEL
Content-Type: application/json
{"action": "in", "badge": "A1B2C3D4"}| Fält | Betydelse |
|---|---|
action | in eller out. |
staff_id / badge / pnr | Identifiera personen med exakt ett av fälten: internt id, brick-/QR-kod eller personnummer. |
Lyckad stämpling svarar med person, händelse och tidsstämpel. Redan incheckad ger 409 och okänd person 404. Varje stämpling skrivs till personalliggaren och kan trigga webhooks.
4. Webhooks – händelser i realtid
Ställ in under Inställningar → Webhooks & chattnotiser i appen. Vid varje händelse postas JSON till er URL, signerat med HMAC-SHA256 så att mottagaren kan verifiera avsändaren.
| Händelse | Triggas när |
|---|---|
checkin | Någon checkar in via stämpelterminal, app eller API. |
checkout | Någon checkar ut; passet väntar sedan på attest. |
break | Rast startas eller avslutas (av som standard). |
leave | Sjukanmälan eller ledighetsansökan registreras. |
POST https://er-server.se/webhook
X-Passa-Event: checkin
X-Passa-Signature: sha256=9f2c…
Content-Type: application/json
{"event":"checkin","org_id":3,"site":"Kvarterskrogen",
"company":"Exempel AB","data":{"staff_id":12,
"name":"Anna Andersson","ts":1760713200000,"method":"stämpelterminal"},
"timestamp":1760713200123,"iso":"2026-10-17T07:00:00+02:00"}Verifiera signaturen (PHP)
$raw = file_get_contents('php://input');
$expected = 'sha256=' . hash_hmac('sha256', $raw, 'ER_HEMLIGA_NYCKEL');
if (!hash_equals($expected, $_SERVER['HTTP_X_PASSA_SIGNATURE'] ?? '')) {
http_response_code(403); exit;
}Den hemliga nyckeln väljer ni själva i inställningarna. Webhooks skickas i bakgrunden och endast till publika https-adresser. Bygg mottagaren idempotent – samma händelse kan i sällsynta fall levereras mer än en gång.
Slack, Microsoft Teams & Discord
Lägg chattens inkommande webhook-URL i fältet ”Slack / Teams / Discord Webhook-URL”, så postas läsbara meddelanden i kanalen – till exempel att Anna Andersson checkade in kl. 07:02.
5. Kalenderflöde (ICS)
?a=ics&token=PERSONLIG_TOKENPrenumerera på schemat i telefonens kalender.Varje användare har en personlig kalenderlänk i appen. Med &all=1 och en chefs token fås hela enhetens schema inklusive godkända ledigheter. Länken är personlig – dela den inte publikt.
6. Publika vyer per enhet
| Vy | Adress | Innehåll |
|---|---|---|
| Incheckning | /incheckning/?k=STÄMPELTERMINALTOKEN | Stämpelklocka för personalen. |
| Närvarotavla | /tavla/?k=STÄMPELTERMINALTOKEN | Vägg-/TV-vy över vilka som är inne just nu. |
| Personalliggare | /liggare/?k=LIGGARTOKEN | Skrivskyddad kontrollvy för Skatteverket. |
| Schemavisare | /schema/?k=STÄMPELTERMINALTOKEN | Endast visning av schemat. |
Tokenarna finns i appen under Inställningar och kan bytas ut där – gamla länkar slutar då att fungera.
Säkerhet & gränser
- Anropa alltid över HTTPS. API-nyckeln ger åtkomst till enhetens stämplings-API och ska behandlas som ett lösenord.
- Nyckeln är unik per enhet och kan roteras om den läckt.
- Vid nätverksfel går samma stämplingsanrop att försöka igen; dubbel incheckning avvisas med 409.
- Personnummer i api_punch loggas aldrig i klartext.
Vill ni koppla ett system?
Mejla oss via kontaktformuläret så hjälper vi er igång med rätt nycklar och ett testanrop.
Boka en demo – 20 minuter