NAV
  • Introduction
  • API version 1
  • API version 2

    • Introduction

    Welcome to EDF Store & Forecast API documentation !

    We have tried to make this documentation user-friendly and example-filled, but if you have any questions, please head to our support team: support@edf-sf.com.

    General documentation about protocols, authentication or supported headers is available below. For more specific documentation regarding API's versions, see documentation for version 1 and version 2. Latest version is version 2.

    Protocols

    The EDF Store & Forecast API uses HTTP GET, PUT and POST requests to communicate and uses HTTP status code to indicate statuses and errors.

    API responses are standard JSON.

    This API is served over TLS v1.2+ with mutual certificates authentication, to ensure identification and data privacy. This means that a TLS protocol handshake between a client and our API occurs before the actual API messages are sent/received.

    Authentication

    Certificate Signing Request generation:

    openssl req -new -newkey rsa:4096 -nodes -out <csr_filename>.csr -keyout <key_filename>.pem

    it will create your CSR <csr_filename>.csr file to send to our support. Keep carefully your private key <key_filename>.pem file on your machine only.

    To authenticate on our API, a valid X.509 certificate signed by EDF Store & Forecast certification authority is required.

    To get one, generate a Certificate Signing Request with openssl tool and send it to our support team: support@edf-sf.com. We will send you back your certificate signed cert.pem and API certification authority certificate ca.cert.pem.

    Headers

    API content support: - Content-Type: application/json mandatory for all requests with a body payload, meaning POST andPUT requests and eventually GET requests.

    API compression support: - Accept-Encoding: gzip: optional for GET requests - Content-Encoding: gzip: optional for PUT requests

    API version 1

    Technical documentation

    This is the legacy version of the EDF Store & Forecast's API. This API has the following features :

    API version 2

    Technical documentation

    This API introduces a new paradigm for production data. Production data is now described with ids refering to attributes of an equipment rather that complete equipment objects. This API has the following features :