What is OAuth 2.0

OAuth 2.0 is an authorization framework that enables third-party applications to obtain limited access to a user’s resources, such as Google Sheets, without requiring the user to share their credentials directly.

It facilitates secure delegation of authorization, allowing users to grant access to their data on a resource server to another application, while keeping their credentials safe.

This protocol is widely used across the internet, providing a standardized and secure way for users to grant access to their data while maintaining control over their privacy and security.

Connecting to an OAuth 2.0 API in Google Sheets with Apipheny

Please note that OAuth is a paid feature in Apipheny. Only users on the Trial, Pro, Business, Enterprise, Legacy, Lifetime, and Unlimited plans can use the OAuth feature in Apipheny. Learn more.

Apipheny is an API Connector for Google Sheets. Apipheny allows users to create custom OAuth 2.0 connections directly from their Google Sheets.

OAuth 2.0 is a robust authentication framework utilized by Apipheny, offering a secure and standardized method for authorizing access to user data without exposing credentials. Through OAuth 2.0, users can grant third-party applications limited access to their resources on Google Sheets without revealing their passwords, ensuring data security and privacy while enabling seamless integration with our API.

Creating a custom OAuth connection in Apipheny is a 2-step process. First you have to open the OAuth editor modal by clicking the OAuth button. After you create an OAuth connection in the modal, you can then choose the OAuth Connection in the dropdown list under the API URL Path field.

Requirements before creating an OAuth integration

Please refer to the API documentation of the API you would like to connect to for instructions on creating an OAuth2.0 connection. The API documentation should have a documented process for defining an OAuth connection.

The process might include the following steps:

  1. Create an “App”
  2. Define the scope of the “App”
  3. Define the Redirect URI of Apipheny within the App

Some apps will accept any redirect URI, and some apps require you to provide a specific Redirect URI. In the app requires a specific Redirect URI, you can provide the following Redirect URI for Apipheny: 

https://script.google.com/macros/d/1MYpnCfUhAB6l3g28CzsMdp7pzNI6Ul9jxC0HVuvVdonQQCxz3O4AVhwU/usercallback

Info needed to define an OAuth 2.0 connection in Apipheny

When creating a custom OAuth 2.0 connection, you will need to input the following information into Apipheny, which you need to obtain from your API provider:

  • Client ID
  • Client Secret
  • Authorization URI
  • Token URI
  • Scopes

In the Scopes field, you should enter a comma-separated list of Scopes required for the API call, with no spaces.

Steps to create a custom OAuth2.0 integration in Apipheny

Creating a custom OAuth connection in Apipheny is a 2-step process. First you have to open the OAuth editor modal (window), where you can connect to an API using OAuth2.0. After you save the OAuth connection in the editor modal, you can then close the modal and choose the OAuth Connection in the dropdown list under the API URL Path field.

1.) In Apipheny, click the OAuth button.

2.) Wait for the modal dialog box (pop up) to open up. In this modal, you can create, edit, view, and delete your OAuth connections.

3.) To create a new OAuth connection, click the Create Connection button in the OAuth modal.

4.) After clicking Create Connection, the following fields will expand. Enter all the details for the OAuth connection.

5.) Click on the Authorize button.

6.) Click the Connect button. The close button appears only after successfully authorizing.

7.) A new window will open and you will be redirected to the web page of the API provider. Enter your login credentials and login. Once you have successfully authenticated and authorized Apipheny, your API access credentials will be automatically transferred to Apipheny. Make sure you have successfully logged in to your API provider, then proceed to the next step.

8.) After successfully completing login to your API provider, you can collapse the Create Connection fields by clicking the Close button. Then, check to make sure your new custom OAuth connection is in the “Connections” list in the modal. Click the Refresh button if you don’t see it. Once confirming your OAuth connection has been saved, you can close the OAuth modal/window/pop-up.

9.) When making your API request in Apipheny, in the “OAuth Connection” dropdown menu, choose the correct connection before making your request:

10.) If you don’t see your saved custom OAuth connection in the dropdown menu, click the Refresh List button.

OAuth Access Expiration

Depending on the API provider and API settings, your credentials may never expire or they may expire within some time frame. If the credentials expire, you will need to re-authenticate.

If you see an error in Apipheny that says “grant is invalid” or “access has expired” for an OAuth connection that was previously working, the most likely cause is that the OAuth access has expired and you need to re-authenticate.

To re-authenticate, follow the same steps stated above. You have to open the OAuth modal, click on the name of the OAuth request you want to re-authenticate, then click on Authorize button followed by the Connect button and login again.



Popular API Tutorials


API Knowledge

What is an API?

What is an API URL?

What are parameters?

What is an endpoint?

What is an API key/token?

What is basic authentication?

What are headers?

What is a GET request?

What is a POST request?

Import JSON to Google Sheets


Need website help? Hire an SEO Consultant.