API Dokumentation

Vår API låter dig integrera serienummerhantering i dina egna system.

Autentisering

För att använda API:et behöver du ett access token. Alla requests förutom Hämta serienummer, måste inkludera följande headers:

Authorization: Bearer ditt-access-token
Accept: application/json

Rate Limiting

API:et har följande begränsningar:

  • Utan token: 1 request per minut
  • Med token: 60 requests per minut

Endpoints

Hämta serienummer

GET /api/v1/serial-numbers/{serialNumber}

Hämtar information om ett specifikt serienummer.

Exempel på svar:

{
    "serial_number": "123456789",
    "status": "OK, STOLEN or OTHER",
    "brand": "Example Brand",
    "category": "Example Category",
    "registered_at": "2025-03-31T10:00:00Z"
}

Registrera serienummer

POST /api/v1/serial-numbers

Registrerar ett nytt serienummer. Kräver autentisering.

Request body:

{
    "serial_number": "123456789",
    "brand_name": "Example Apple",
    "category_name": "Example Smartphone",
    "display_name": "Example My iPhone",
    "purchase_date": "2025-03-31"
}

Uppdatera status

PUT /api/v1/serial-numbers/{serialNumber}

Uppdaterar status för ett serienummer. Kräver autentisering.

Request body:

{
    "status": "inactive"
}

Ta bort serienummer

DELETE /api/v1/serial-numbers/{serialNumber}

Tar bort ett serienummer. Kräver autentisering.

Felhantering

API:et använder standard HTTP statuskoder och returnerar felbeskrivningar i JSON-format:

{
    "error": "Felmeddelande här",
    "code": "ERROR_CODE"
}

Statuskoder

  • 200: OK
  • 201: Skapad
  • 400: Ogiltig förfrågan
  • 401: Ej autentiserad
  • 403: Åtkomst nekad
  • 404: Hittades inte
  • 429: För många förfrågningar
  • 500: Serverfel

Exempel på kod i PHP Curl

Här är ett exempel på hur du kan använda API:et i PHP med access token:

                 
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://sndb.io/api/v1/serial-numbers/ABC123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$headers = array();
$headers[] = 'Authorization: Bearer YOUR_ACCESS_TOKEN';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($ch);
if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); }
curl_close($ch);
echo $result;

Här är ett exempel på hur du kan använda API:et i PHP utan access token:

                 
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://sndb.io/api/v1/serial-numbers/ABC123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); }
curl_close($ch);
echo $result;