{ "openapi": "3.0.1", "info": { "title": "OCPI 2.2.1 API Tester: CPO and eMSP Endpoint Validation", "description": "OCPI 2.2.1 API tester and validator for EV charging roaming. Point it at a CPO or eMSP versions URL and get a pass, warn or fail report for versions, credentials, locations, tariffs, sessions, CDRs and tokens. Paste-JSON mode for offline checks. Pay per endpoint tested.", "version": "0.0", "x-build-id": "oal5IYeaEH75lt2LQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tiger19935~ocpi-conformance-tester/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tiger19935-ocpi-conformance-tester", "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~ocpi-conformance-tester/runs": { "post": { "operationId": "runs-sync-tiger19935-ocpi-conformance-tester", "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~ocpi-conformance-tester/run-sync": { "post": { "operationId": "run-sync-tiger19935-ocpi-conformance-tester", "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", "properties": { "mode": { "title": "Mode", "enum": [ "validate", "payload", "selftest" ], "type": "string", "description": "What to do. `validate` - test a live OCPI endpoint (empty URL runs a free demo) `payload` - validate a pasted OCPI response or object offline `selftest` - health check (for schedules)", "default": "validate" }, "versionsUrl": { "title": "Versions URL", "type": "string", "description": "Public https URL of the OCPI versions endpoint, for example https://cpo.example.com/ocpi/versions. Private and local addresses are blocked. Empty = free demo." }, "token": { "title": "Token", "type": "string", "description": "OCPI token for the Authorization header. It is never written to the output or logs." }, "tokenEncoding": { "title": "Token encoding", "enum": [ "base64", "plain" ], "type": "string", "description": "OCPI 2.2.1 sends the token base64 encoded after the word Token. Choose plain only for platforms that skip the encoding.", "default": "base64" }, "role": { "title": "Role under test", "enum": [ "CPO", "EMSP" ], "type": "string", "description": "CPO exposes locations, tariffs, sessions and CDRs as sender. eMSP exposes tokens as sender.", "default": "CPO" }, "modules": { "title": "Modules", "type": "array", "description": "Which modules to test. Empty = locations, tariffs, sessions, cdrs, tokens, credentials. Allowed: locations, tariffs, sessions, cdrs, tokens, credentials, commands.", "items": { "type": "string" } }, "depth": { "title": "Depth", "enum": [ "quick", "standard", "full" ], "type": "string", "description": "quick: 3 objects per module. standard: 25. full: 100 objects and the full report fee.", "default": "standard" }, "module": { "title": "Module (payload mode)", "enum": [ "locations", "tariffs", "sessions", "cdrs", "tokens", "credentials" ], "type": "string", "description": "Module of the pasted JSON in payload mode.", "default": "locations" }, "json": { "title": "JSON (payload mode)", "type": "object", "description": "A pasted OCPI response (with status_code and data), a list of objects or one object." }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Cap on billable rows (module summaries) per run.", "default": 100 } } }, "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 } } } } } } } } } }