Tutorials>RingCentral Password Flow Authentication OAuth - PHP

In this step-by-step tutorial, you are going to learn how to authenticate RingCentral platform using password flow in PHP programming language. Click the "Start" button below to start the tutorial.

Start Tutorial

Clone and Setup the project

Clone the project from GitHub and install RingCentral PHP SDK and dependencies.

Create a RingCentral app

If you don't know how to create a RingCentral app. Click here for instructions.

Set Environment Variables

Copy the Client id and Client secret and add them to the .env-sandbox file.


Add the account login credentials to the .env-sandbox file.


If you want to specify variables for your production environment, repeat this step for the .env-production file.

Authenticate using RingCentral PHP SDK

Using a RingCentral SDK is the most convenient way to authenticate and and access RingCentral platform services.

Let's start by creating a file named rc_authenticate.php.

Includes the _bootstrap.php file, which will load PHP modules and import the SDK namespace.

Load the environment variables

We read the ENVIRONMENT value from the .env file and load the .env-sandbox or .env-production accordingly.

Specify a .txt file to keep the authentication data

For the sandbox environment, we save the data to the tokens_sb.txt.

For the production environment, we save the data to the tokens_pd.txt.

In your real application, you may want to secure the authentication data in a database or in a safe place as it contains the access token and the refresh token!

Create a reusable class

To make this tutorial code reusable and extensible, we define the RC_Authentication class and implement a couple utility functions.


Create an SDK instance

First we implement the get_sdk() function to instantiate the SDK and return the $sdk instance.

To instantiate the $sdk, we pass the client id, client secret and the platform environment parameters.

Get the $platform instance from the SDK

Now we implement the get_platform function.

First we call the get_sdk() function to get the $sdk instance.

Then we call the $sdk->platform() to retrieve the $platform instance.

Call the login() function

Now we authenticate a user by calling the $platform->login() function, passing the username, extension_number and password.

Upon success, we will write the authentication data to a local file and return the $platform instance to a caller function.

Read the saved authentication data

Every time we call the get_platform() function, we get the $platform instance from the $sdk, read the authentication data we saved locally and call the $platform->auth()->setData($tokenObj) function, passing along the authentication data.

Then we call the $platform->loggedIn() function to check if we are still logged in or not. The SDK will automatically validate the access token's and the refresh token's expiration time and return true if the user is still authenticated. Otherwise, the function returns false and we proceed to the login procedure as discussed in the previous step.

Use the RC_Authentication class

Now let's create a file demo.php and use the RC_Authentication class as shown in the demo code on the right-hand side.

In this demo, we call the account extension endpoint to read extensions' information and print them out on the console.

Run the demo app.

$ php demo.php