Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cariqa Charging Sessions API

The Charging Sessions API from Cariqa — 4 operation(s) for charging sessions.

Cariqa Charging Sessions API is one of 7 APIs that Cariqa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Charging Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a quickstart.

This API exposes 5 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0 (v1).

Requests are made against 2 base URLs: https://connect.cariqa.com, https://dev.connect.cariqa.com.

5 operations 4 paths 13 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0 (v1)
Base URL
https://connect.cariqa.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cariqa Charging Sessions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT Authorization header using the Bearer scheme.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Charging Sessions 5
GET
/api/v1/users/{user_id}/charging-sessions/
List Charging Sessions
users_charging_sessions_list 3 params → 200403404
GET
/api/v1/users/{user_id}/charging-sessions/{session_id}/
Get Charging Session
users_charging_sessions_retrieve 2 params → 200403404
PATCH
/api/v1/users/{user_id}/charging-sessions/{session_id}/
Rate charging session
users_charging_sessions_partial_update 2 params body → 200400403404
POST
/api/v1/users/{user_id}/charging/start/
Start Charging Session
users_charging_start_create 1 param body → 201402403404409424500
POST
/api/v1/users/{user_id}/charging/stop/{session_id}/
Stop Charging Session
users_charging_stop_create 2 params → 204403404409424500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are PatchedConnectAPIChargingSession (13 properties), ConnectAPIChargingSession (13 properties), ConnectAPIPAYGSummary (11 properties), StationInfo (9 properties). Each schema is shown below with its type and property counts.

PaginatedConnectAPIChargingSessionList
object
4 properties 2 required
RatesEnum
integer
1 - 1 2 - 2 3 - 3 4 - 4 5 - 5
ErrorDetail
object
2 properties 2 required
ConnectAPIUserFacingSessionPrices
object
8 properties 7 required
ConnectAPIChargingSession
object
13 properties 12 required
ErrorTypeEnum
string
validationerror - validationerror paymentmethoderror - paymentmethoderror paymenterror - paymenterror temporarylocked - temporarylocked alreadycharging - alrea…
ConnectAPIPAYGSummary
object
PAYG summary serializer.
11 properties 11 required
NullEnum
Detail
object
400 status error message response serializer.
1 property 1 required
Error
object
3 properties 2 required
PatchedConnectAPIChargingSession
object
13 properties
StationInfo
object
9 properties
ConnectAPIStartChargingRequest
object
Start charge request serializer. :param evseid: Evse id of the station to charge at. :param paymentmethodid: Stripe id of the payment method which should be us…
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cariqa-charging-sessions-api-openapi.yml Raw ↑

Other APIs Cariqa publishes across the network.

Cariqa Billing Details API
Cariqa Debts API
Cariqa Invoices API
Cariqa Payments API
Cariqa Stations API
Cariqa Users API