Settings View Source README

Überauth Ameritrade

Ameritrade OAuth2 strategy for Überauth.

installation

Installation

1. Setup your application at Ameritrade Developers.

2. Add :ueberauth_ameritrade to your list of dependencies in mix.exs:

    def deps do
      [{:ueberauth_ameritrade, "~> 1.0.0"}]
    end

3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_ameritrade]]
    end

4. Add Ameritrade to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        ameritrade: {Ueberauth.Strategy.Ameritrade, []}
      ]

5. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.Ameritrade.OAuth,
     client_id: System.get_env("AMERITRADE_KEY")

6. Include the Überauth plug in your controller:

   defmodule MyApp.AuthController do
     use MyApp.Web, :controller
     plug Ueberauth
     ...
   end

7. Create the request and callback routes if you haven't already:

   scope "/auth", MyApp do
     pipe_through :browser
   
     get "/:provider", AuthController, :request
     get "/:provider/callback", AuthController, :callback
   end

   And make sure to set the correct redirect URI(s) in your Ameritrade application to wire up the callback.

8. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth Example application.

calling

Calling

Depending on the configured url you can initialize the request through:

/auth/td

You must use something other than Ameritrade in the callback routes, I use /auth/td see below:

config :ueberauth, Ueberauth,
  providers: [
    ameritrade: {Ueberauth.Strategy.Ameritrade,  [request_path: "/auth/td", callback_path: "/auth/td/callback"]}
  ]

license

License

Please see LICENSE for licensing details.