Hjælp

API-reference

REST API med JSON. Godkendelse med API-nøgle i headeren Authorization: Bearer. Nøgler oprettes under Indstillinger, API, og har afgrænsede rettigheder.

POST-kald understøtter headeren Idempotency-Key. Samme nøgle med samme indhold giver samme svar i 24 timer.

Godkendelse

export BASE_URL="https://…"   # adressen på din konto
curl -H "Authorization: Bearer $API_KEY" "$BASE_URL/api/v1/products"

Endpoints

GET/api/v1/batteries

Hent batterimodeller med kategori, batteripas og hvor mange af kravene til 18.02.2027 der er besvaret. Filtrér med category.

Rettighedbatteries:read
Parametre
  • category string · forespørgsel
  • per_page integer · forespørgsel
  • page integer · forespørgsel
Svar200 · 401

GET/api/v1/batteries/{id}

Hent én batterimodel med batteripas og parathed.

Rettighedbatteries:read
Parametre
  • id integer · sti · påkrævet
Svar200 · 404

GET/api/v1/batteries/{id}/units

Hent de registrerede enkeltbatterier (serienumre) for en batterimodel med status og adressen på hvert batteris pas.

Rettighedbatteries:read
Parametre
  • id integer · sti · påkrævet
  • per_page integer · forespørgsel
  • page integer · forespørgsel
Svar200 · 404

POST/api/v1/batteries/{id}/units

Registrér eller opdatér enkeltbatterier, højst 1.000 pr. kald. Et kendt serienummer opdateres; felter, I udelader, bliver stående.

Rettighedbatteries:write
Parametre
  • id integer · sti · påkrævet
  • Idempotency-Key string · header
Svar201 · 422

GET/api/v1/products

Hent en side med produkter og deres emballagetyper. Brug per_page (højst 100) og page.

Rettighedproducts:read
Parametre
  • per_page integer · forespørgsel
  • page integer · forespørgsel
Svar200 · 401

POST/api/v1/products

Opret et produkt. Send en Idempotency-Key, så et gentaget kald ikke opretter produktet to gange.

Rettighedproducts:write
Parametre
  • Idempotency-Key string · header
Svar201 · 422 · 429

GET/api/v1/products/{id}

Hent ét produkt med dets emballagetyper.

Rettighedproducts:read
Parametre
  • id integer · sti · påkrævet
Svar200 · 404

GET/api/v1/passports

Hent udgivne batteri- og produktpas med deres GS1 Digital Link-adresser.

Rettighedpassports:read
Svar200

GET/api/v1/declarations

Hent udstedte EU-overensstemmelseserklæringer med nummer og version.

Rettigheddeclarations:read
Svar200

Grænser pr. abonnement

API'et er med fra Pro. Pro: 1.000 kald i timen. Business: 5.000 kald i timen. Går I over, svarer API'et 429 med en Retry-After, der siger, hvornår I kan prøve igen. Enterprise aftales individuelt.

OpenAPI-specifikation (openapi.yaml)