Products

API change history

API to handle products

GetProductById

Allows to get Information for a specific product ID

Try it

Request

Request URL

https://gateway-preview.be-mo.io/products/v1/api/{id}

Request parameters

  • string

Request headers

  • string

    A JwtToken generated by GetVehicleToken

  • string
    Subscription key which provides access to this API. Found in your Profile.

Responses

200 OK

Success

Representations

{
  "status": "Success",
  "errors": null,
  "data": {
    "id": "c52d5a-kwGoTkYwNTk3OTQE",
    "code": "B7",
    "description": null,
    "category": "Fueling",
    "placeType": "Station",
    "placeId": "NF059794",
    "available": true,
    "allowed": true,
    "address": "53-55 RUE DE L' ALMA  ",
    "countryKey": "FR",
    "cityKey": "COURBEVOIE",
    "zipCode": "92400",
    "latitude": 48.896848,
    "longitude": 2.254516,
    "attributes": [],
    "placeName": "RELAIS DE L'ALMA",
    "placeNetwork": "Total",
    "placeNetworkId": "TOT",
    "openingTimes": {
      "regularHours": [
        {
          "weekDay": "Monday",
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        },
        {
          "weekDay": "Tuesday",
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        },
        {
          "weekDay": "Wednesday",
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        },
        {
          "weekDay": "Thursday",
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        },
        {
          "weekDay": "Friday",
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        },
        {
          "weekDay": "Saturday",
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        },
        {
          "weekDay": "Sunday",
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        }
      ],
      "exceptionalOpenings": [],
      "exceptionalClosings": []
    },
    "ePayment": true,
    "digitalJourney": true,
    "displayedPrices": [
      {
        "description": null,
        "quantityUnit": "L",
        "unitPrice": 1.37,
        "stepSize": 1,
        "currencyKey": "EUR"
      }
    ],
    "tariffCodes": {
      "defaultCode": "BM-04",
      "specificPeriods": [
        {
          "code": "BM-01",
          "tag": null,
          "weekDay": null,
          "periodBegin": "HH:MM",
          "periodEnd": "HH:MM"
        }
      ]
    },
    "timeZone": "+02:00",
    "score": {
      "digitalScore": 92.0,
      "physicalScore": 87.0,
      "networkDigitalScore": 56.0,
      "networkPhysicalScore": 75.0
    }
  },
  "version": "1.0"
}
{
  "allOf": [
    {
      "properties": {
        "status": {
          "enum": [
            "Success",
            "Error"
          ],
          "type": "string",
          "description": "Code describing the status of the response"
        },
        "errors": {
          "type": "array",
          "items": {
            "required": [
              "code",
              "message"
            ],
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "Code of the error."
              },
              "message": {
                "type": "string",
                "description": "Readable message describing the error."
              }
            }
          }
        },
        "version": {
          "type": "string",
          "description": "Version number of the response"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Unique id of the product"
                  },
                  "code": {
                    "enum": [
                      "B7",
                      "B10"
                    ],
                    "type": "string",
                    "description": "Id of the product"
                  },
                  "description": {
                    "type": "string",
                    "description": "Specific description of the product."
                  },
                  "category": {
                    "enum": [
                      "Fueling",
                      "Charging",
                      "Washing",
                      "Parking"
                    ],
                    "type": "string",
                    "description": "Category of the product"
                  },
                  "placeType": {
                    "type": "string",
                    "description": "Place type where the product can be consumed"
                  },
                  "placeId": {
                    "type": "string",
                    "description": "Technical Id of the place where the product can be consumed"
                  },
                  "available": {
                    "type": "boolean",
                    "description": "true if the product is available at this place."
                  },
                  "allowed": {
                    "type": "boolean",
                    "description": "True if digital consumption of product is allowed by your subscription."
                  },
                  "address": {
                    "type": "string",
                    "description": "Street address of the place."
                  },
                  "countryKey": {
                    "type": "string",
                    "description": "ISO alpha-2 country code."
                  },
                  "cityKey": {
                    "type": "string"
                  },
                  "zipCode": {
                    "type": "string"
                  },
                  "placeName": {
                    "type": "string",
                    "description": "User-friendly name of the place."
                  },
                  "placeNetwork": {
                    "type": "string",
                    "description": "Network of this product."
                  },
                  "placeNetworkId": {
                    "type": "string",
                    "description": "Network id of this product."
                  },
                  "ePayment": {
                    "type": "boolean",
                    "description": "Deprecated, true if product available for digital journey.",
                    "deprecated": true
                  },
                  "digitalJourney": {
                    "type": "boolean",
                    "description": "true if product available for digital journey."
                  },
                  "latitude": {
                    "maximum": 90.0,
                    "minimum": -90.0,
                    "type": "number",
                    "description": "Latitude of the place."
                  },
                  "longitude": {
                    "maximum": 180.0,
                    "minimum": -180.0,
                    "type": "number",
                    "description": "Longitude of the place."
                  },
                  "openingTimes": {
                    "type": "object",
                    "properties": {
                      "regularHours": {
                        "type": "object",
                        "properties": {
                          "weekDay": {
                            "enum": [
                              "Monday",
                              "Tuesday",
                              "Wednesday",
                              "Thursday",
                              "Friday",
                              "Saturday",
                              "Sunday"
                            ],
                            "type": "string"
                          },
                          "periodBegin": {
                            "pattern": "([0-1][0-9]|2[0-3]):[0-5][0-9]",
                            "type": "string",
                            "description": "Opening hour. Local time."
                          },
                          "periodEnd": {
                            "pattern": "([0-1][0-9]|2[0-3]):[0-5][0-9]",
                            "type": "string",
                            "description": "Closing hour. Local time."
                          }
                        },
                        "description": "Regular business hours."
                      },
                      "exceptionalOpenings": {
                        "type": "object",
                        "properties": {
                          "description": {
                            "type": "string",
                            "description": "Friendly description of the period. (Ex. maintenance, holidays)"
                          },
                          "periodBegin": {
                            "type": "string",
                            "description": "UTC time",
                            "format": "date-time"
                          },
                          "periodEnd": {
                            "type": "string",
                            "description": "UTC time",
                            "format": "date-time"
                          }
                        }
                      },
                      "exceptionalClosings": {
                        "type": "object",
                        "properties": {
                          "description": {
                            "type": "string",
                            "description": "Friendly description of the period. (Ex. maintenance, holidays)"
                          },
                          "periodBegin": {
                            "type": "string",
                            "description": "UTC time",
                            "format": "date-time"
                          },
                          "periodEnd": {
                            "type": "string",
                            "description": "UTC time",
                            "format": "date-time"
                          }
                        }
                      }
                    }
                  },
                  "attributes": {
                    "type": "array",
                    "items": {
                      "pattern": "(connector|capability).\\w",
                      "type": "string",
                      "description": "Attributes describing capabilities of the place."
                    }
                  },
                  "displayedPrices": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "description": {
                          "type": "string",
                          "description": "Friendly description of the price."
                        },
                        "quantityUnit": {
                          "enum": [
                            "L",
                            "kWh",
                            "s",
                            "Flat",
                            "Unknown"
                          ],
                          "type": "string",
                          "description": "Quantity unit of this price."
                        },
                        "unitPrice": {
                          "type": "number",
                          "description": "Unit price"
                        },
                        "stepSize": {
                          "type": "integer",
                          "description": "Indicates the step size. Means for how many quantity unit (s, L, etc.) the current price is available."
                        },
                        "currencyKey": {
                          "type": "string",
                          "description": "Currency key (ISO 4217)"
                        }
                      }
                    }
                  },
                  "tariffCodes": {
                    "type": "object",
                    "properties": {
                      "defaultCode": {
                        "pattern": "BM-([0-1][0-9]|20)",
                        "type": "string",
                        "description": "Default tariff code applicable to this period."
                      },
                      "specificPeriods": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "code": {
                              "pattern": "BM-([0-1][0-9]|20)",
                              "type": "string",
                              "description": "Tariff code applicable to this period."
                            },
                            "tag": {
                              "type": "string",
                              "description": "Describes this specific tariff reason (ex: night/day)."
                            },
                            "weekDay": {
                              "enum": [
                                "Monday",
                                "Tuesday",
                                "Wednesday",
                                "Thursday",
                                "Friday",
                                "Saturday",
                                "Sunday"
                              ],
                              "type": "string"
                            },
                            "periodBegin": {
                              "pattern": "([0-1][0-9]|2[0-3]):[0-5][0-9]",
                              "type": "string",
                              "description": "Starting hour. UTC time."
                            },
                            "periodEnd": {
                              "pattern": "([0-1][0-9]|2[0-3]):[0-5][0-9]",
                              "type": "string",
                              "description": "End hour. UTC time."
                            }
                          },
                          "description": "Specific tariff period."
                        }
                      }
                    },
                    "description": "Describes tariff classification for this product."
                  },
                  "timeZone": {
                    "type": "string"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "distance": {
                    "type": "number",
                    "description": "Distance from your position in km."
                  }
                }
              }
            ]
          }
        }
      }
    }
  ]
}

401 Unauthorized

Unauthorized

Representations

{
  "TokenExpired": {
    "status": "Error",
    "errors": [
      {
        "code": "TokenExpired",
        "message": "Lifetime validation failed, the JWT is expired."
      }
    ],
    "version": "1.0"
  }
}
{
  "properties": {
    "status": {
      "enum": [
        "Success",
        "Error"
      ],
      "type": "string",
      "description": "Code describing the status of the response"
    },
    "errors": {
      "type": "array",
      "items": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error."
          },
          "message": {
            "type": "string",
            "description": "Readable message describing the error."
          }
        }
      }
    },
    "version": {
      "type": "string",
      "description": "Version number of the response"
    }
  }
}

403 Forbidden

Forbidden

Representations

{
  "status": "Error",
  "errors": [
    {
      "code": "InvalidJWT",
      "message": "Unable to decode the JWT."
    }
  ],
  "version": "1.0"
}
{
  "properties": {
    "status": {
      "enum": [
        "Success",
        "Error"
      ],
      "type": "string",
      "description": "Code describing the status of the response"
    },
    "errors": {
      "type": "array",
      "items": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error."
          },
          "message": {
            "type": "string",
            "description": "Readable message describing the error."
          }
        }
      }
    },
    "version": {
      "type": "string",
      "description": "Version number of the response"
    }
  }
}

404 Not Found

Not found

Representations

{
  "status": "Error",
  "errors": [
    {
      "code": "Not found",
      "message": "Item not found."
    }
  ],
  "version": "1.0"
}
{
  "properties": {
    "status": {
      "enum": [
        "Success",
        "Error"
      ],
      "type": "string",
      "description": "Code describing the status of the response"
    },
    "errors": {
      "type": "array",
      "items": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error."
          },
          "message": {
            "type": "string",
            "description": "Readable message describing the error."
          }
        }
      }
    },
    "version": {
      "type": "string",
      "description": "Version number of the response"
    }
  }
}

500 Internal Server Error

Internal server error

Representations

{
  "status": "Error",
  "errors": [
    {
      "code": "ErrorCode",
      "message": "Error message/description."
    }
  ],
  "version": "1.0"
}
{
  "properties": {
    "status": {
      "enum": [
        "Success",
        "Error"
      ],
      "type": "string",
      "description": "Code describing the status of the response"
    },
    "errors": {
      "type": "array",
      "items": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error."
          },
          "message": {
            "type": "string",
            "description": "Readable message describing the error."
          }
        }
      }
    },
    "version": {
      "type": "string",
      "description": "Version number of the response"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://gateway-preview.be-mo.io/products/v1/api/{id}"
-H "Authorization: "
-H "Api-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("Api-Subscription-Key", "{subscription key}");

            var uri = "https://gateway-preview.be-mo.io/products/v1/api/{id}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://gateway-preview.be-mo.io/products/v1/api/{id}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            request.setHeader("Api-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://gateway-preview.be-mo.io/products/v1/api/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Api-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://gateway-preview.be-mo.io/products/v1/api/{id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Api-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://gateway-preview.be-mo.io/products/v1/api/{id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Api-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '',
    'Api-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
    conn.request("GET", "/products/v1/api/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '',
    'Api-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('gateway-preview.be-mo.io')
    conn.request("GET", "/products/v1/api/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://gateway-preview.be-mo.io/products/v1/api/{id}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Api-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body