tyler.durden
/
opensupports
mirror of https://github.com/opensupports/opensupports.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes a typo and a path in the backend docs

This commit is contained in:
Maxi Redigonda 2017-12-25 23:06:58 -03:00
parent 4528c74022
commit e3ca2c5e52
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
server/API_STANDARD.md
View File

@ -2,7 +2,7 @@ OpenSupports can work completely fine without a frontend. You could only use thi
This documentation is intended for application developers who are looking to integrate OpenSupports with other applications.
## Request/Response Interface
The API server is located in the `api/` folder of your OpenSupports' instance folder.
The API server is located in the `server/` folder of your OpenSupports' instance folder.
**All the requests must be done via POST method**, with the exception of the path `/system/download`.
The response object has the following JSON structure:
@ -37,4 +37,4 @@ This request will return you the session data with an `userId` and a `token`. Yo
If you don't pass the userId and token, a `NO_PERMISSION` error will be returned.
Additionally, if there is no users (only staff members), you can check a ticket you created by providing your email and the ticketNumber to the `/ticket/check` path. This path will return you a `token` and `ticketNumber` you will use to comment, retrieve, or do any other operations to the ticket.
Additionally, if there are no users (only staff members), you can check a ticket you created by providing your email and the ticketNumber to the `/ticket/check` path. This path will return you a `token` and `ticketNumber` you will use to comment, retrieve, or do any other operations to the ticket.