Developing an original API function with doorkeeper and oauth2.

1 min readMay 4, 2021

I have had an opportunity to develop an API login function between two web services. The way to do that is a little complex and demanding, so I’ve decided to take a not about necessary knowledge.

Gems

doorkeeper-gem/doorkeeper

Doorkeeper is a gem (Rails engine) that makes it easy to introduce OAuth 2 provider functionality to your Ruby on Rails…

github.com

This is a gem by which you can develop an API feature easily. Moreover, I used this gem for oauth.

omniauth/omniauth-oauth2

This gem contains a generic OAuth2 strategy for OmniAuth. It is meant to serve as a building block strategy for other…

github.com

That’s all.

System

With these gems, user can be given a permission, which means an access token, from an authorization server. This system is defined as RFC6749. The details is here.

RFC 6749 - The OAuth 2.0 Authorization Framework

Internet Engineering Task Force (IETF) D. Hardt, Ed. Request for Comments: 6749 Microsoft Obsoletes: 5849 October 2012…

tools.ietf.org

Wrap up

You can make an API feature with the knowledge above. I hope that this information would be a help to you.