Access and authorisation

Access to GreenFlux APIs is provided through authentication tokens.

Currently there are different Tokens for:

  • 'Platform' APIs - CPOs, EMSP and Smart Charging
  • Charge Assist API

Platform subscription

Platform subscriptions are typically used by CPOs to get a copy of the data of 'their' charge stations.

GreenFlux largely follows the OCPI 2.1.1 standard with regards to API Platform connections.

Requesting a Platform subscription

Please contact your Customer Success or Account Manager to start this process.
Note: There may be one-off setup fees involved.

Process

  1. Initiate process via Customer Success Manager
  2. Meeting with both parties to align on scope and discuss requirements
  3. Setup of Test/Acceptance environment & exchange of tokens. See Environments
  4. Testing & validation
  5. Setup of Production environment & exchange of tokens
  6. Testing & validation

Scope

CPOs can have multiple sub-CPOs. GreenFlux can create subscriptions that will share any number of these CPOs.

Upon requesting a Platform subscription, please specify whether all or a specific number of CPOs are in scope.

Timeline

Requests are typically handled within several working days.

Typically setting the endpoints and underlying DB or data-lake capabilities as well as testing is the key determining factor for timelines. We see that this can take several weeks.

Transport & Format

GreenFlux supports both Pull and Push (WebHook) models.

  • Pull: Receiver request a (full) list of objects every X times.
  • Push: Changes in objects and new objects are sent (semi) real-time to the receiver.

Pull

Setup & Authorization

Setting up a Pull endpoint is relatively straightforward. GreenFlux needs to know:

  • which modules to enable
  • which CPOs to include

Push / webhooks

Endpoint format for Push requests

For Push requests, GreenFlux requires endpoints for each module to be setup (CDR, Session, Location etc.)

  • your-company-url.com/cdrs
  • your-company-url.com/locations
  • your-company-url.com/sessions
  • your-company-url.com/notifications

For Session and Location endpoints, GreenFlux will attach the {country-code}, {party-id} and {object-id} at the end.

Example:

  • your-company-url.com/sessions/NL/GFX/NLGFX63759510021327674-7f844
  • your-company-url.com/locations/NL/GFX/f24214df-6c8a-4236-b217-82ec52291e803

For CDRs, there is no further information attached to the end.

For ChargeStationNotifications, the ID is attached to the end:

  • your-company-url.com/ChargeStationNotifications/0cbfb073-2c9a-4cc0-819a-afe60be36088

For more detail, please look at the Guides for each of these modules.

Response status for Push messages

We recommend to implement the OCPI response format
See section 4.1.6 and section 5 for list of error codes: https://evroaming.org/app/uploads/2020/06/OCPI-2.2-d2.pdf

}
"status_code": 1000,
"status_message": "Success",
"timestamp": "2021-06-30T21:59:59Z"
}

Authorization

For GreenFlux to push to Customer’s platform, we require an authorization Token.
GreenFlux Push messages will include an 'Authorization' header:

The header looks as follows:

Authorization: Token IpbJOXxkxOAuKR92z0nEcmVF3Qw09VG7I7d/WCg0koM=

Exchanging Authorization

For Pull access to the GreenFlux platform, we will provide you with an authorization Token.

Checklist

Activity

Activity

Responsible party

Setup of environment (Access, Locations, Chargers, billing rules etc)

Customer supported by CSM

PULL

Setup API connection (Modules, CPOs connected)

GreenFlux

Token exchanged for Pull/GET access

PUSH (if requested)

Setup endpoints & services

Customer

Share endpoints with GreenFlux

Customer

Exchange authentication Token to GreenFlux

Customer

Testing & Validation

Both

Setup production environment (Same list)

FAQ

Whitelisting

Please request information on our IP addresses in case you wish to whitelisting incoming requests

Bespoke Headers

Currently GreenFlux only support the Authorization headers as described above.

Custom or bespoke headers may be reviewed in the future.

Multiple platform subscriptions

For administration, we highly recommend one subscription per CPO.

If you wish to request a copy of information to a partner (e.g. for research purposes), ideally the CPO should create a forwarding functionality. Depending on the use case, this can also be setup by GreenFlux.


Did this page help you?