To start your Phoenix app:
- Install required Erlang and Elixir versions:
- Install asdf package manager
asdf plugin-add erlangto add Erlang plugin
asdf plugin-add elixirto add Elixir plugin
asdf installto install plugin versions speicifed in
- Install dependencies with
apps/api_accountsfollowing directions in
apps/api_accounts/README.md(on GitHub or ExDoc)
- Start Phoenix endpoint with
Now you can visit
localhost:4000 from your browser.
In addition to the Elixir config files, the V3 API allows runtime configuration through a collection of environment variables.
||Cookie binary for the Erlang VM.|
||Space-separated Phoenix types the API will accept.|
||Log level to use. Can be changed to
||The HTTP port the server will listen on.|
||undefined||The public-facing hostname for the server, used to generate URLs.|
||URL for the GTFS .zip file.|
||URL for the Alerts. Can be either a JSON or Protobuf file.|
||URL for the TripUpdates. Can be either a JSON or Protobuf file.|
||URL for the VehiclePositions. Can be either a JSON or Protobuf file.|
||undefined||URL for parking information.|
||undefined||S3 bucket to which we write files we fetched.|
Swagger documentation for the Api is generated automatically.
Want to contribute?
Thank you for wanting to contribute! We use the built in
mix format for code formatting, and
ExUnit for testing.
# Format all code $ mix format # Run all unit tests $ mix test # Run the integration tests $ mix test --exclude test --include integration
- Docs: https://www.mbta.com/developers/v3-api
- Mailing list: https://groups.google.com/forum/#!forum/massdotdevelopers
The MBTA Customer Technology team is working to transform how people get around the Boston area. We’re a small but mighty team of designers, engineers and content specialists charged with bringing novel ideas, modern standards and a user-centered approach to technology on the T. As the MBTA works to reinvent itself, we have a rare opportunity to shape the future of transportation for Boston and communities all around Eastern Massachusetts, as well as blaze a trail for other transit agencies around the country.
We’re always looking for people to join the team who are passionate about improving the daily transportation experience for our 400 million annual riders. Does this sound like you? Check our our open positions at https://jobs.lever.co/mbta/.