Difference between revisions of "M4 API v2"
From Kolmisoft Wiki
Jump to navigationJump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
=M4 users that are allowed to use M4 API v2= | =M4 users that are allowed to use M4 API v2= | ||
* Admin | * Admin | ||
* | * Manager with DIDs and Subscription permissions | ||
<br><br> | <br><br> | ||
| Line 12: | Line 12: | ||
=Usage= | =Usage= | ||
Open GUI using M4 IP/domain http://IP_or_Domain/billing/api/v2 and put M4 IP/Domain to host.<br> | Open GUI using M4 IP/domain http://IP_or_Domain/billing/api/v2/api-docs/ and put M4 IP/Domain to host.<br> | ||
[[File:M4_api_v2_host.png]] | [[File:M4_api_v2_host.png]] | ||
| Line 20: | Line 20: | ||
[[File:M4_api_v2_tryitout.png]] | [[File:M4_api_v2_tryitout.png]] | ||
Enter User credentials (Admin or | Enter User credentials (Admin or Manager) and press '''Execute'''.<br> | ||
[[File:M4_api_v2_user_credentials.png]] | [[File:M4_api_v2_user_credentials.png]] | ||
| Line 37: | Line 37: | ||
[[File:M4_api_v2_authorize3.png]] | [[File:M4_api_v2_authorize3.png]] | ||
Now you can use available APIs.<br> | Now you can use available APIs. Expand them to see the documentation.<br> | ||
[[File:M4_api_v2_available_apis.png]] | [[File:M4_api_v2_available_apis.png]] | ||
Latest revision as of 09:36, 3 June 2024
About
M4 API lets other software interact with M4 without knowing the internal structure of the database (DB) and other logic.
M4 users that are allowed to use M4 API v2
- Admin
- Manager with DIDs and Subscription permissions
Usage
Open GUI using M4 IP/domain http://IP_or_Domain/billing/api/v2/api-docs/ and put M4 IP/Domain to host.
Expand the authentication and press on Try it out.
Enter User credentials (Admin or Manager) and press Execute.
Copy the token and use it for authorization.
Note: the token is valid for 2 hours.
Close the window when authorized.
Now you can use available APIs. Expand them to see the documentation.
