Chouette Convert User Manual

Chouette Convert User Manual

How the Chouette Convert API works

Chouette Convert is an API for converting a data file into another format (GTFS, NeTEx, etc.).

This API is only accessible via a secure HTTPS URL. The HTTPS protocol (Hyper Text Transfer Protocol Secure) is a secure extension of the HTTP protocol. The “S” stands for “Secured,” meaning that the data exchanged between the user's browser and the website is encrypted and cannot be spied on (confidentiality) or modified (integrity). In the browser's address bar, the URL used will be HTTP with a green padlock and the word “Secure.”

You will be provided with a token to convert and retrieve the file on this API.

Below are the conversions supported by the API:

  • Neptune => GTFS

  • GTFS => NeTEx

  • NeTEx => NeTEx

For NeTEx, several profiles can be used :

  • Français

  • Européen

Command line conversion

enRoute also provides an open source client. A description of how to use it is available on the Bitbucket repository:

https://bitbucket.org/enroute-mobi/secretary-client/src/main/

You will find executables for all platforms in the sources (see “Downloads” in the menu).

Once you have retrieved your token, you can include it in a configuration file. ~/.secretary-client.yaml :

convert-token: "here-your-token"

Then simply launch a conversion with the secretary-client:

➜ secretary-client create conversion --type=gtfs-netex --profile=european gtfs.zip Using config file: /home/user/.secretary-client.yaml Conversion a0c06700-9cd9-4f5e-b194-721d370a16d5 created for gtfs.zip

 

Several types of conversion can be used:

  • Neptune => GTFS : type=neptune-gtfs

  • GTFS => NeTEx : type=gtfs-netex

  • NeTEx => NeTEx : type=netex-netex

as well as several NeTEx profiles:

  • french : --profile=french

  • european : --profile=european