Skip to content

janetruluck/ueberauth_instagram

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Überauth Instagram

License

Instagram OAuth2 strategy for Überauth.

Installation

  1. Setup your application at Instagram Developers.

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

    def deps do
      [{:ueberauth_instagram, "~> 0.1"}]
    end
  3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_instagram]]
    end
  4. Add Instagram to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        instagram: {Ueberauth.Strategy.Instagram, []}
      ]
  5. Update your provider configuration:

    config :ueberauth, Ueberauth.Strategy.Instagram.OAuth,
      client_id: System.get_env("INSTAGRAM_CLIENT_ID"),
      client_secret: System.get_env("INSTAGRAM_CLIENT_SECRET")
  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
  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

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

/auth/instagram

Or with options:

/auth/instagram?scope=basic

By default the requested scope is "public_content". Scope can be configured either explicitly as a scope query value on the request path or in your configuration:

config :ueberauth, Ueberauth,
  providers: [
    instagram: {Ueberauth.Strategy.Instagram, [default_scope: "basic,public_content,followers_list"]}
  ]

See Instagram API Reference > Login Permissions for full list of scopes.

License

Please see LICENSE for licensing details.

About

Instagram OAuth2 Strategy for Überauth.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages