Munkaterület-adminisztrációs API végpontkérései és válaszai

Ez minden /v2/admin végpont kérés-/válaszreferenciája. A hitelesítést, idempotenciát, sebességkorlátokat, tokenlétrehozást és a hatókörök jelentését a Munkaterület-adminisztrációs API dokumentálja. Az újrafelhasználható mezőszintű típusok és példák a Sémák és példák oldalon találhatók. Minden végpontsort a Válasz- és hibaszerződéssel együtt olvasson, amely az összes lehetséges közös és végpontspecifikus sikertelen választörzset felsorolja.

Közös szerződés

Minden elérési út a telepített app-api eredettel kezdődik. A munkaterület kizárólag a hitelesített tokenből származik; a kliensek nem küldhetnek cpoId értéket. Minden dokumentált :...Id erőforrásútvonal-érték pozitív decimális egész szám. Minden kéréshez pontosan egy szükséges:

Authorization: Bearer <workspace-access-token>

A JSON-törzzsel jelzett kérésekhez Content-Type: application/json szükséges. Minden módosításhoz Idempotency-Key (POST, PUT, PATCH és DELETE) kell, beleértve a(z) POST /v2/admin/reports/send műveletet is; ha a sor nem jelzi másként, a sikeres válasz tartalomtípusa application/json, a JSON-dátumok RFC 3339 karakterláncok, a számok pedig JSON-számok.

Minden kérés tartalmazhat X-Request-Id és X-Error-Format: envelope fejlécet; lásd a Válasz- és hibaszerződést. Ezek a fejlécek nem módosítják a sikersémákat.

Az alább használt jelölések:

• A(z) none azt jelenti, hogy nincs kéréstörzs. A JSON-törzset dokumentáló DELETE továbbra is igényli azt a törzset.
• A(z) ? opcionális tulajdonságot vagy lekérdezési paramétert jelöl.
• A(z) T | null azt jelenti, hogy a tulajdonság jelen van, és null is lehet.
• A(z) 204 empty azt jelenti, hogy nincs választörzs.
• A(z) CursorPage<T> jelentése { items: T[], nextCursor: number|string|null }, kivéve ha a sor kifejezetten page vagy pagination objektumot nevez meg.
• Minden hiányzó beágyazott erőforrás, beleértve a más munkaterülethez tartozó azonosítókat is, 404 { "error": "Workspace resource not found", "code": "RESOURCE_NOT_FOUND" } választ használ, kivéve ha egy funkció konkrétabb ütközést dokumentál.

Közös kéréssémák

Munkaterület- és helyszínbemenetek

WorkspacePatch = {
  name?: string(1..100), email?: email|null, website?: string|null,
  addressLine1?: string|null, addressLine2?: string|null,
  postalCode?: string|null, city?: string|null, state?: string|null,
  countryId?: positive integer
} // at least one property

SiteInput = {
  name: string(1..255), description?: string|null = null,
  addressLine1?: string|null = null, addressLine2?: string|null = null,
  postalCode?: string|null = null, city?: string|null = null, state?: string|null = null,
  countryId: positive integer, timezoneId: positive integer,
  latitude?: number[-90,90]|null = null, longitude?: number[-180,180]|null = null
}

Teljesítménykezelési bemenet

PowerConfigurationInput = { pools: PowerPoolInput[0..200] }
PowerPoolInput = {
  id?: positive integer|null, name?: string(0..255),
  limit: integer[0,100000000], meterSources?: ExternalMeterInput[0..16],
  children?: (PowerPoolInput | ChargerPoolChild)[0..1000]
}
ChargerPoolChild = { chargepointId: positive integer, priority?: integer[-1000000,1000000] }
ExternalMeterInput = {
  id?: positive integer|null, sourceId?: positive integer|null,
  provider?: "perific", name?: string(0..255), externalId: string(1..80),
  measurementMode?: "available_headroom"|"external_non_ev_load_only"|"total_site_load_including_ev",
  valueMode?: "perific_relative"|"perific_direct"|"perific_meter",
  reserveA?: integer[0,100000], offlineSafeA?: integer[0,100000],
  ttlSeconds?: integer[30,86400], enabled?: boolean
}

Töltőbemenetek

ChargerCreate = { name: string(1..40), identifier: string(1..40), password?: string(0..40) = "", siteId: positive integer }
ChargerPatch = {
  name?: string(1..40), siteId?: positive integer, invertedRfid?: boolean,
  smartMode?: integer[0,3], automationDisabled?: boolean
} // at least one
ConnectorPatch = {
  connectorFormatId: positive integer, connectorTypeId: positive integer,
  powerTypeId: positive integer, maxVoltage: integer[1,10000],
  maxAmperage: integer[1,10000], maxElectricPower: integer[1,100000000]
}

Jelentésbemenetek

ReportFilters = {
  from?: RFC3339, to?: RFC3339, siteId?: positive integer,
  chargerId?: positive integer, userId?: positive integer,
  anonymous?: true|false|1|0, active?: true|false|1|0
}
ReportScheduleInput = {
  enabled: boolean, recipientEmail: email(max 255; may be empty only when disabled), format: "csv"|"pdf",
  sendDay: integer[1,28], sendTime: UTC "HH:mm"
}

A jelentéstartományoknak meg kell felelniük a(z) from < to feltételnek, és legfeljebb 90 naposak lehetnek. Elhagyásukkor a legutóbbi 90 nap érvényesül. A(z) userId és anonymous=true kölcsönösen kizárja egymást. Az ütemezett exportok pótolják az elmulasztott UTC-percet, és korlátozott újrapróbálkozásokat használnak (5/10 perces várakozás, elavult foglaláshoz 30 perces időtartam, három kísérlet).

Tarifabemenetek

TariffInput = {
  name: string(1..64),
  exactly one of currencyId: positive integer, currencyCode: 3 letters, currency: 3 letters,
  biddingZoneId?: positive integer|null, tax?: finite number
}
TariffComponentInput = {
  typeId: positive integer, seasonId: positive integer, priority?: finite number,
  price: finite number, validFromMonth?: finite number, validToMonth?: finite number,
  validFromWeekDay?: finite number, validToWeekDay?: finite number,
  validFromHour?: finite number, validToHour?: finite number
}
TariffAssignmentCreateInput = { tariffId: positive integer, connectorId?: nonnegative integer }
TariffAssignmentUpdateInput = { tariffId: positive integer, connectorId: positive integer }

Töltésiprofil-bemenetek

ChargingProfileInput = {
  label: string(1..40), locationId: positive integer, stackLevel: nonnegative number,
  purposeId: positive integer, kindId: positive integer,
  recurrencyKindId?: positive integer|null, validFrom?: RFC3339|null,
  validTo?: RFC3339|null, startSchedule?: RFC3339|null,
  rateUnitId: positive integer, minChargingRate?: nonnegative number|null
}
ChargingProfileCreate = ChargingProfileInput & { schedule?: SchedulePeriod[0..256] }
SchedulePeriod = { startPeriod: nonnegative number, limit: nonnegative number, numberOfPhases?: positive integer|null }
ChargingScheduleInput = { rateUnitId: positive integer, periods: SchedulePeriod[1..256] }
ProfileAssignmentInput = { profileId: positive integer, connectorId?: nonnegative integer }

Felhasználói bemenetek

UserCreate = { email: email(max 255), name: string(1..255) }
InvitationInput = {
  email: email, name?: string|null, rfid?: string|null,
  allChargers?: boolean, chargerIds?: unique positive integer[0..500]
} // chargerIds must be non-empty unless allChargers=true
AccessInput = { allChargers?: boolean, chargerIds?: unique positive integer[0..500] }
LimitCreate = { limitTypeId: positive integer, energyValue?: nonnegative integer = 0, timeValue?: nonnegative integer = 0 }
LimitPatch = { limitTypeId?: positive integer, energyValue?: nonnegative integer, timeValue?: nonnegative integer }

Korlát létrehozásakor a(z) energyValue vagy timeValue érték közül legalább az egyiknek nullánál nagyobbnak kell lennie. Az e-mail-címek szélső szóközeit a rendszer eltávolítja, és kisbetűssé alakítja őket. Az RFID UID-k csak íráskor fogadhatók el, az olvasási válaszokban maszkoltak.

Válasz-DTO-k összefoglalója

A végponttáblázatok minden legfelső szintű válaszburkolót mutatnak. Ezek a burkolók fő újrafelhasználható DTO-i:

A lista-/részletútvonalak hivatkozási objektumokat adnak vissza, hogy a hívók megtalálhassák az érvényes azonosítókat. Az ismeretlen új mezőket kezelje jövőbeli verziókkal kompatibilisként, és csak dokumentált stabil mezők és hibakódok alapján ágaztassa el a programot.

Munkaterület-végpontok

Helyszín- és teljesítménykezelési végpontok

Töltővégpontok

Jelentésvégpontok

Tarifavégpontok

A(z) TariffAssignment tartalma: id, chargerId, connectorId, biztonságos tarifa-/pénznemösszefoglaló, createdAt és updatedAt.

Töltésiprofil-végpontok

A(z) ProfileAssignment tartalmazza a hozzárendelés azonosítóját, a töltő/csatlakozó azonosítóit és a profil biztonságos összefoglalóját. Az OCPP-eredményobjektumok stabil kérés-/állapotadatokat mutatnak, hitelesítő adatokat soha.

Felhasználó-, RFID-, hozzáférés-, korlát- és helyifelhasználó-végpontok

A Tagless-rendszerfelhasználó védett ezektől a műveletektől. A meghívó e-mail hibái biztonságos kézbesítési állapotot adnak vissza SMTP-részletek kiszivárogtatása nélkül; a hívók újrapróbálkozhatnak, ha a(z) emailRetryReady igaz.

Bináris válaszok

Két végpontcsalád siker esetén nem ad JSON-t:

A bináris végpontok hibái továbbra is JSON-formátumúak.