Home Arrow Icon Knowledge base Arrow Icon Global Arrow Icon How do I create a REST API token in Joomla 5


How do I create a REST API token in Joomla 5


To create a REST API token in Joomla 5, follow these steps:

1. Log in to your Joomla administrator panel as a Super User.

2. Create a new user account specifically for API access (recommended for better security and management)[5]:
- Go to Users > Manage
- Click "New" to create a new user
- Assign appropriate permissions (Super User if full access is needed)

3. Access the user profile for the API user:
- Go to Users > Manage
- Click on the username of the API user you created

4. Navigate to the "Joomla API Token" tab in the user profile[1][3].

5. Read the information provided about API tokens.

6. Save the user profile. This will generate the API token[3].

7. Log in as the new API user to view and copy the generated token[3].

Important notes:

- Keep the token secret, as it provides access to your Joomla site's API[3].
- By default, only Super Users can generate API tokens[3].
- For more granular control, you can create a specific user group for API access and configure permissions accordingly[2].
- The token does not automatically invalidate or regenerate after a specific time[5]. You'll need to manage token rotation manually if required.

Remember to always use HTTPS when making API requests to ensure the security of your token and data[4].

Citations:
[1] https://stackoverflow.com/questions/32755023/how-to-install-and-use-joomla-rest-api-step-by-step
[2] https://joomla.stackexchange.com/questions/33327/how-to-authenticate-a-user-with-the-official-joomla-4-rest-api
[3] https://slides.woluweb.be/api/api.html
[4] https://learn.getcapi.org/api-methods/joomla-api-routes/token/get-token-token
[5] https://forum.joomla.org/viewtopic.php?t=988364