API docs by Redocly

CPS API (1.0)

Download OpenAPI specification:

CharIN e.V.: coordination@charin.global URL: https://charin.global License: Attribution-ShareAlike 4.0 International

CPS services API.

SignContractData

SignContractData

This interface signs contract data in the CPS and sends it back to the eMSP. By using the Parameter PCID the Signed Contract Data are getting stored in the Contract Certificate Pool.

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Request Body schema: application/json
required
object (contractCertificateBundleV1)

Contract certificate bundle consisting of the contract certificate and its chain not including the eMSP Root CA itself. Furthermore the encrypted contract private key and the DH Public Key as descirbed in the ISO 15118 is included

xsdMsgDefNamespace
required
string (xsdMsgDefNamespaceParamV1)
Default: "urn:iso:15118:2:2013:MsgDef"
Enum: "urn:iso:15118:2:2013:MsgDef" "urn:iso:15118:20:2020:MsgDef"

ISO15118 Version

cpsV2GRootCertificateFingerprint
string (cpsV2GRootCertificateFingerprintParamV1) ^[0-9a-fA-F]{64}$

The SHA256 Fingerprint of the desired V2G root CA which shall was used to sign these data with the regarding CPS signing certificate. Its optional. If not given, the CPS will decide which CPS signing V2G PKI will be renurned

Responses

Request samples

Content type
application/json
{
  • "contractCertificateBundle": {
    },
  • "xsdMsgDefNamespace": "urn:iso:15118:2:2013:MsgDef",
  • "cpsV2GRootCertificateFingerprint": "311f28ff13da6d75f836ac10644b34273da99564c600a191fb3737d50562a4f1"
}

Response samples

Content type
application/json
{
  • "signedContractData": {
    }
}

GenerateAndSignContractData

GenerateAndSignContractData

This service creates and signs contractData for provided contract information. The contract certificate will be signed by the eMSP SUB CA2 which is derived from the V2G Root CA

The created and signed contractData is stored in the contract certificate pool for provisioning to the OEM- and CPO-backend.

To update a contractData, the interface must be called again with the same PCID and EMAID. The system will replace the old contractData with the new one.

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Request Body schema:
contractBegins
required
string

Timestamp the contract will begin at.

contractEnds
required
string

Timestamp until the contract is active.

emaid
required
string (emaidParamV1) [ 14 .. 36 ] characters ^[A-Za-z]{2}[-]?\w{3}[-]?\w{9,28}[-]?(\w{1})?...

E-Mobility Authentication Identifier (Note: separators will be normalized by the system due to ISO restrictions)

pcid
required
string (pcidParamV1) [ 17 .. 18 ] characters ^[a-zA-Z0-9]{17,18}$
xsdMsgDefNamespace
required
string (xsdMsgDefNamespaceParamV1)
Default: "urn:iso:15118:2:2013:MsgDef"
Enum: "urn:iso:15118:2:2013:MsgDef" "urn:iso:15118:20:2020:MsgDef"

ISO15118 Version

subscriptionUrl
string^(https?|http)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]...

URL which could be given by eMSP to allow extended information exchange for a given contract

cpsV2GRootCertificateFingerprint
string (cpsV2GRootCertificateFingerprintParamV1) ^[0-9a-fA-F]{64}$

The SHA256 Fingerprint of the desired V2G root CA which shall was used to sign these data with the regarding CPS signing certificate. Its optional. If not given, the CPS will decide which CPS signing V2G PKI will be renurned

moRootCertificateFingerprint
string (emspRootCertificateFingerprintParamV1) ^[0-9a-fA-F]{64}$

The SHA256 Fingerprint of the desired eMSP root CA from which the CC will derive. It is optional. If not given, the PKI service operator will decide from which eMSP Root CA the issued CC will derive

metaData
string

Placeholder for future adaption

Responses

Request samples

Content type
{
  • "contractBegins": "string",
  • "contractEnds": "string",
  • "emaid": "stringstringst",
  • "pcid": "stringstringstrin",
  • "xsdMsgDefNamespace": "urn:iso:15118:2:2013:MsgDef",
  • "subscriptionUrl": "https://testemsp.com/subscriptions/v2g",
  • "cpsV2GRootCertificateFingerprint": "311f28ff13da6d75f836ac10644b34273da99564c600a191fb3737d50562a4f1",
  • "moRootCertificateFingerprint": "311f28ff13da6d75f836ac10644b34273da99564c600a191fb3737d50562a4f1",
  • "metaData": "string"
}

Response samples

Content type
application/json
Example
{
  • "errorMessages": [
    ],
  • "traceId": "3e002e2a-580b-48e4-88a5-6b782cae636b"
}

GetCpsCertificates

GetCpsCertificates

Get CPS certificates incl. certificate chain.

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Responses

Response samples

Content type
{
  • "cpsCertificateDataCollection": [
    ]
}