{ "openapi": "3.0.1", "info": { "title": "OCPP CSMS Smoke Test — Virtual Charge Point", "description": "A virtual OCPP 1.6J charge point connects to your own CSMS, plays boot, charging and responder scenarios and returns a step-by-step PASS/WARN/FAIL report. Built for CSMS developers and integrators. Authorized use only; not a certification, load or security tool. Pay per completed run.", "version": "1.0", "x-build-id": "K7a3cQdRD7yZtFeh3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tiger19935~ocpp-csms-smoke-test/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tiger19935-ocpp-csms-smoke-test", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/tiger19935~ocpp-csms-smoke-test/runs": { "post": { "operationId": "runs-sync-tiger19935-ocpp-csms-smoke-test", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/tiger19935~ocpp-csms-smoke-test/run-sync": { "post": { "operationId": "run-sync-tiger19935-ocpp-csms-smoke-test", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "endpoint", "chargePointId", "iAmAuthorized" ], "properties": { "endpoint": { "title": "CSMS WebSocket endpoint", "type": "string", "description": "Base URL of the OCPP-J WebSocket endpoint, e.g. wss://csms.example.com/ocpp. The charge point id is appended to the path unless you switch that off below. Do not put credentials in the URL (use Basic authentication below)." }, "chargePointId": { "title": "Charge point ID", "pattern": "^[A-Za-z0-9._-]{1,48}$", "type": "string", "description": "Identity of the virtual charge point as your CSMS knows it (1-48 characters: letters, digits, dot, underscore, hyphen). Use a dedicated test charge point, never the id of a real station." }, "appendChargePointId": { "title": "Append the charge point ID to the URL path", "type": "boolean", "description": "OCPP-J connects to /. Switch off only if your endpoint URL already contains the id.", "default": true }, "ocppVersion": { "title": "OCPP version", "enum": [ "1.6J" ], "type": "string", "description": "Only OCPP 1.6J (JSON, subprotocol ocpp1.6) is supported. OCPP 2.0.1 is on the roadmap.", "default": "1.6J" }, "authType": { "title": "Authentication", "enum": [ "none", "basic" ], "type": "string", "description": "HTTP Basic authentication in the WebSocket handshake (OCPP security profile 1 or 2 over TLS). Client certificates (mTLS) are not supported.", "default": "none" }, "username": { "title": "Username", "type": "string", "description": "Username for HTTP Basic authentication (often the charge point id). Used only when Authentication is 'HTTP Basic'. Must not contain a colon." }, "password": { "title": "Password", "type": "string", "description": "Password or authorization key for HTTP Basic authentication. Used only when Authentication is 'HTTP Basic'. Never logged, stored or returned by this Actor." }, "scenario": { "title": "Scenario", "enum": [ "connect", "boot", "basic-charge", "responder" ], "type": "string", "description": "connect = WebSocket handshake and subprotocol only. boot = + BootNotification, StatusNotification, Heartbeat. basic-charge = + Authorize, a short charging transaction with meter values and stop. responder = boot, then stay connected and answer CSMS-initiated commands.", "default": "basic-charge" }, "idTag": { "title": "ID tag", "pattern": "^[ -~]{1,20}$", "type": "string", "description": "RFID / idTag used for Authorize and StartTransaction (max 20 printable ASCII characters). It must be known and accepted by your CSMS for the basic-charge scenario.", "default": "TESTTAG1" }, "connectorId": { "title": "Connector ID", "minimum": 1, "maximum": 99, "type": "integer", "description": "Connector number used in StatusNotification, StartTransaction and MeterValues.", "default": 1 }, "vendor": { "title": "Charge point vendor", "pattern": "^[ -~]{1,20}$", "type": "string", "description": "chargePointVendor sent in BootNotification (max 20 characters).", "default": "ApifySmoke" }, "model": { "title": "Charge point model", "pattern": "^[ -~]{1,20}$", "type": "string", "description": "chargePointModel sent in BootNotification (max 20 characters).", "default": "VCP-1" }, "meterStartWh": { "title": "Meter start (Wh)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Energy register value in Wh at the start of the simulated session. Two meter samples (+50 Wh, +100 Wh) follow.", "default": 0 }, "chargeSeconds": { "title": "Charging time (seconds)", "minimum": 1, "maximum": 30, "type": "integer", "description": "How long the simulated charging session lasts between StartTransaction and StopTransaction (basic-charge scenario).", "default": 3 }, "responderSeconds": { "title": "Responder time (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "How long the virtual charge point stays connected and answers CSMS commands (responder scenario). Commands are only acknowledged, nothing is executed.", "default": 60 }, "iAmAuthorized": { "title": "I am authorized to test this CSMS", "type": "boolean", "description": "Tick to confirm that you own this CSMS or have the operator's permission to connect a test charge point to it. This Actor is not a load or security testing tool, and runs against one host are limited to 3 per hour.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }