Požiadavky a odpovede koncových bodov administrátorského API pracovného priestoru

Toto je referencia požiadaviek a odpovedí pre každý koncový bod /v2/admin. Autentifikácia, idempotencia, limity frekvencie, vytváranie tokenov a význam rozsahov sú zdokumentované v časti Administrátorské API pracovného priestoru. Opakovane použiteľné typy polí a príklady sú v časti Schémy a príklady. Každý riadok koncového bodu čítajte spolu s Kontraktom odpovedí a chýb, ktorý uvádza všetky možné spoločné a špecifické telá neúspešných odpovedí.

Spoločný kontrakt

Každá cesta začína pôvodom nasadenej služby app-api. Pracovný priestor sa odvodzuje výhradne z autentifikovaného tokenu; klienti nesmú posielať cpoId. Všetky zdokumentované hodnoty :...Id v cestách zdrojov sú kladné desiatkové celé čísla. Každá požiadavka vyžaduje presne jednu:

Authorization: Bearer <workspace-access-token>

Požiadavky zobrazené s telom JSON vyžadujú Content-Type: application/json. Všetky zmenové operácie vyžadujú Idempotency-Key (POST, PUT, PATCH a DELETE) vrátane POST /v2/admin/reports/send; pokiaľ riadok neuvádza inak, typ obsahu úspešnej odpovede je application/json, dátumy JSON sú reťazce RFC 3339 a čísla sú čísla JSON.

Každá požiadavka môže obsahovať X-Request-Id a X-Error-Format: envelope; pozrite Kontrakt odpovedí a chýb. Tieto hlavičky nemenia schémy úspešných odpovedí.

Označenia použité nižšie:

• none znamená žiadne telo požiadavky. DELETE, pri ktorom je zdokumentované telo JSON, ho stále vyžaduje.
• ? označuje voliteľnú vlastnosť alebo parameter dopytu.
• T | null znamená, že vlastnosť je prítomná a môže byť null.
• 204 empty znamená žiadne telo odpovede.
• CursorPage<T> znamená { items: T[], nextCursor: number|string|null }, okrem prípadu, keď riadok výslovne pomenúva objekt page alebo pagination.
• Všetky prípady chýbajúceho vnoreného zdroja vrátane ID z iných pracovných priestorov používajú 404 { "error": "Workspace resource not found", "code": "RESOURCE_NOT_FOUND" }, pokiaľ funkcia nedokumentuje konkrétnejší konflikt.

Spoločné schémy požiadaviek

Vstupy pracovného priestoru a lokality

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
}

Vstup riadenia výkonu

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
}

Vstupy nabíjačiek

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]
}

Vstupy výkazov

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"
}

Rozsahy výkazov musia spĺňať from < to a nesmú presiahnuť 90 dní. Pri vynechaní sa použije posledných 90 dní. userId a anonymous=true sa navzájom vylučujú. Plánované exporty dobiehajú zmeškanú minútu UTC a používajú obmedzené opakovania (odstup 5/10 minút, 30-minútová rezervácia zastaranej úlohy, tri pokusy).

Vstupy taríf

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 }

Vstupy nabíjacích profilov

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 }

Vstupy používateľov

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 }

Pri vytváraní limitu musí byť aspoň jedno z energyValue alebo timeValue väčšie než nula. Z e-mailov sa odstránia okrajové medzery a písmená sa zmenia na malé. RFID UID sa prijímajú iba pri zápise a v odpovediach na čítanie sú maskované.

Súhrn DTO odpovedí

Tabuľky koncových bodov zobrazujú každú obálku odpovede na najvyššej úrovni. Toto sú hlavné opakovane použiteľné DTO v týchto obálkach:

Referenčné objekty vracajú trasy zoznamov a podrobností, aby volajúci mohli zistiť platné ID. Neznáme pridané polia považujte za rozšírenia kompatibilné s budúcimi verziami a rozhodujte sa iba podľa zdokumentovaných stabilných polí a chybových kódov.

Koncové body pracovného priestoru

Koncové body lokalít a riadenia výkonu

Koncové body nabíjačiek

Koncové body výkazov

Koncové body taríf

TariffAssignment obsahuje id, chargerId, connectorId, bezpečný súhrn tarify/meny, createdAt a updatedAt.

Koncové body nabíjacích profilov

ProfileAssignment obsahuje ID priradenia, ID nabíjačky/konektora a bezpečný súhrn profilu. Objekty výsledkov OCPP sprístupňujú stabilné údaje o požiadavke/stave a nikdy prihlasovacie údaje.

Koncové body používateľov, RFID, prístupu, limitov a lokálnych používateľov

Systémový používateľ Tagless je pred týmito operáciami chránený. Zlyhania odoslania pozvánky e-mailom vracajú bezpečný stav doručenia bez odhalenia podrobností SMTP; volajúci môžu skúsiť znova, keď má emailRetryReady hodnotu true.

Binárne odpovede

Dve skupiny koncových bodov pri úspechu nevracajú JSON:

Chyby binárnych koncových bodov sú stále vo formáte JSON.