How to Test Token based Authentication in API by Playwright

















What Is Token-Based Authentication? Complete Guide to Handling Token Authentication in Playwright Java

In today’s modern web applications and APIs, security is not optional—it is essential. One of the most widely used and secure authentication mechanisms is Token-Based Authentication. Whether you are building applications, consuming APIs, or performing automation testing, understanding how token authentication works is crucial.

If you are using Playwright with Java for API or UI automation, learning how to handle token-based authentication will allow you to bypass login screens, test secured endpoints, and build scalable automation frameworks.

In this detailed, SEO-optimized, and AdSense-friendly guide, you will learn:

  • What token-based authentication is

  • How JWT (JSON Web Token) works

  • Complete authentication workflow

  • How to handle token-based authentication in Playwright Java

  • Step-by-step API testing example

  • How to reuse authenticated state

  • How to manage token expiry

  • Best practices for secure automation

This guide is written in a natural, human-friendly tone and is perfect for beginners and experienced testers alike.


What Is Token-Based Authentication?

Token-based authentication is a secure method used to verify the identity of a user or system trying to access a protected resource such as:

  • REST APIs

  • Web applications

  • Microservices

  • Mobile backends

Instead of sending a username and password repeatedly with every request, the server issues a token after successful login.

This token acts as a temporary access key.

The most common token format used today is:

  • JWT (JSON Web Token)

A JWT is a secure, digitally signed string that contains user information and expiration details.


Why Token-Based Authentication Is Preferred Over Basic Authentication

Unlike Basic Authentication, where credentials are sent with every request, token-based authentication:

  • Reduces exposure of credentials

  • Improves scalability

  • Works well with stateless APIs

  • Supports expiration and refresh mechanisms

  • Integrates easily with modern frontend frameworks

Because of these benefits, most modern systems use token authentication instead of traditional username-password validation per request.


How Token-Based Authentication Works (Step-by-Step)

Let’s break down the typical workflow.


Step 1: User Login

The user sends credentials (email & password) to an authentication endpoint.

Example:

POST /api/login

Request body:

{ "email": "user@example.com", "password": "password123" }


Step 2: Token Issuance

If credentials are valid:

  • The server generates a token (often JWT)

  • The token is signed and optionally encrypted

  • The token is sent back to the client

Example response:

{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }


Step 3: Client Uses Token

The client stores the token:

  • In memory

  • In localStorage

  • In sessionStorage

  • In cookies

For every subsequent request, the token is added to the header:

Authorization: Bearer <token>


Step 4: Server Validates Token

The server:

  • Verifies signature

  • Checks expiration

  • Validates claims

  • Grants or denies access


Step 5: Token Expiry & Refresh

Tokens usually expire after a defined time.

To avoid re-login:

  • A refresh token may be used

  • A new access token is generated


What Is JWT (JSON Web Token)?

JSON Web Token (JWT) is the most commonly used token format.

A JWT contains three parts:

  1. Header

  2. Payload

  3. Signature

Structure:

header.payload.signature

JWT is:

  • Compact

  • Secure

  • Digitally signed

  • Stateless

Because it is stateless, the server does not need to store session data.


Why Token-Based Authentication Is Important in Automation Testing

In real-world automation scenarios:

  • Login pages slow down test execution

  • UI-based login adds instability

  • API tests require authentication

  • Microservices require secure access

By handling token authentication programmatically:

  • You can skip UI login

  • You can test secured APIs directly

  • You can speed up test execution

  • You can build reusable test frameworks

This is where Playwright Java becomes powerful.


Handling Token-Based Authentication in Playwright Java

Playwright provides strong API testing support using APIRequestContext.

To handle token authentication in Playwright Java:

  1. Obtain token

  2. Store token

  3. Attach token to headers

  4. Call protected APIs

  5. Validate response

Let’s go step-by-step.


Example Scenario Using ReqRes API

We will use:

  • Login endpoint

  • Users endpoint

Provided by:

ReqRes

Login Endpoint:

https://reqres.in/api/login

Users Endpoint:

https://reqres.in/api/users/2


Maven Dependency

Add this dependency to your pom.xml:

<dependency> <groupId>com.microsoft.playwright</groupId> <artifactId>playwright</artifactId> <version>1.44.0</version> </dependency>


Complete Java Code: Token-Based Authentication in Playwright

import com.microsoft.playwright.*; import com.microsoft.playwright.options.*; import java.util.*; public class TokenBasedAuthTest { public static void main(String[] args) { try (Playwright playwright = Playwright.create()) { APIRequestContext request = playwright.request().newContext(); // Step 1: Login to get the token APIResponse loginResponse = request.post("https://reqres.in/api/login", RequestOptions.create() .setHeader("Content-Type", "application/json") .setData("{ \"email\": \"eve.holt@reqres.in\", \"password\": \"cityslicka\" }") ); if (loginResponse.status() != 200) { System.out.println("Login failed! Status: " + loginResponse.status()); return; } // Step 2: Extract token String token = loginResponse.json().get("token").toString(); System.out.println("Token received: " + token); // Step 3: Use token in Authorization header APIResponse userResponse = request.get("https://reqres.in/api/users/2", RequestOptions.create() .setHeader("Authorization", "Bearer " + token) ); System.out.println("User API Status Code: " + userResponse.status()); System.out.println("User API Response: " + userResponse.text()); if (userResponse.status() == 200) { System.out.println("Token-based API access successful."); } else { System.out.println("Access failed."); } } } }


Code Explanation (Detailed)


Step 1: Create APIRequestContext

playwright.request().newContext();

This acts like an HTTP client.


Step 2: Send Login Request

request.post("https://reqres.in/api/login", ...)

We send credentials in JSON format.


Step 3: Extract Token

loginResponse.json().get("token").toString();

This retrieves the token from response JSON.


Step 4: Attach Token to Header

.setHeader("Authorization", "Bearer " + token)

This is the most important step.

Without this header, the server will deny access.


Step 5: Validate Protected Endpoint

We check:

  • Status code

  • Response body

If 200 → Success
If 401 → Unauthorized


Expected Output

Token received: QpwL5tke4Pnpja7X4 User API Status Code: 200 Token-based API access successful.


Using Token in Browser-Based Testing

For UI automation:

You may need to inject token into:

LocalStorage

page.evaluate("localStorage.setItem('token', '" + token + "')");


SessionStorage

page.evaluate("sessionStorage.setItem('token', '" + token + "')");


Cookies

context.addCookies(...)

After injecting the token, navigate to the application.

This bypasses login screen completely.


Reusing Authenticated State in Playwright

Playwright allows saving authentication state:

context.storageState(new BrowserContext.StorageStateOptions().setPath("auth.json"));

Later reuse:

browser.newContext(new Browser.NewContextOptions().setStorageStatePath(Paths.get("auth.json")));

This improves performance in large test suites.


Handling Token Expiry

Tokens expire for security reasons.

Best practices:

  1. Always generate token before test execution

  2. Store token temporarily

  3. Use refresh token flow if supported

  4. Avoid hardcoding tokens


Security Best Practices

Do Not Hardcode Credentials

Use:

  • Environment variables

  • Config files

  • CI/CD secrets


Use HTTPS Only

Tokens should never travel over HTTP.


Avoid Logging Sensitive Tokens

Do not print tokens in production logs.


Common Mistakes in Token-Based Testing

  • Forgetting "Bearer " prefix

  • Using expired tokens

  • Hardcoding token strings

  • Not validating login response

  • Mixing API and UI tokens incorrectly


When Should You Use Token-Based Authentication in Automation?

You should use token-based authentication when:

  • Testing REST APIs

  • Testing microservices

  • Bypassing UI login

  • Working with modern web applications

  • Testing secured endpoints


Advantages of Token-Based Authentication in Playwright

  • Faster test execution

  • More stable automation

  • Reduced UI dependency

  • Better scalability

  • Cleaner framework design


Final Thoughts

Token-based authentication is the backbone of modern API security. It provides a scalable, secure, and efficient way to manage user access without exposing credentials repeatedly.

By combining:

  • Token authentication

  • Playwright Java

  • APIRequestContext

  • State reuse

You can build a powerful and scalable automation framework capable of testing enterprise-level secure applications.

If you are serious about mastering API automation, understanding token-based authentication in Playwright Java is not optional—it is essential.


Suggested Posts:

1. Automate GET API in Playwright
2. Automate POST API in Playwright
3. Automate PUT API in Playwright
4. Test Cookie Based Authentication in Playwright
5. Basic Authentication in Playwright