UniqueSoft/openpanel
2
0
Fork 0
mirror of https://github.com/stefanpejcic/openpanel synced 2025-06-26 18:28:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update api.md

Browse Source
This commit is contained in:
Radovan Ječmenica 2025-04-30 15:19:08 +02:00 committed by GitHub
parent cdc1174787
commit ffc9e6ddff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/docs/admin/settings/api.md
View File

@ -4,30 +4,30 @@ sidebar_position: 3
# API Access # API Access
Use the API Access section to interact with the OpenPanel API directly from your dashboard. This tool allows you to test API calls, view request/response examples, monitor API logs, and experiment with endpoints in a simple interface. Use the API Access page to test API calls, view request/response examples, monitor API logs, and experiment with endpoints in a simple interface.
To begin: To begin:
1. **Enable API Access** 1. **Enable API Access**
Toggle the Enable API Access option to activate the interface for testing API requests. Toggle the Enable API Access option to activate the interface for testing API requests.
2. **Fill the Request Form** 3. **Fill the Request Form**
Once enabled, you will see a form with the following fields:
- **GET** – Choose the HTTP method (currently supports GET). Once enabled, you will see a form with the following fields:
- **Method** – Choose the HTTP method.
- **URL** – Enter the API endpoint you wish to call. - **URL** – Enter the API endpoint you wish to call.
- **USERNAME** - Enter admin username.
- **TOKEN** – Paste your authentication token for authorization. - **PASSWORD** - Enter admin password.
- **TOKEN** – token that was generated with username and password combination.
- **DATA** – (Optional) Provide any data or parameters required by the endpoint. - **DATA** – (Optional) Provide any data or parameters required by the endpoint.
3. Send Request 5. **Send Request**
Click the Send Request button to execute the API call. Click the Send Request button to execute the API call.
5. View API Logs and Curl command 7. **View API Logs and Curl command**
After making a request, the response, curl command and log details will appear at the bottom. This includes request info, server response, status codes, and any error messages. After making a request, the response, curl command and log details will appear at the bottom. This includes request info, server response, status codes, and any error messages.