Testing requests on REST API in Postman: Difference between revisions
From Planfix
No edit summary |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 6: | Line 6: | ||
}} | }} | ||
To test and debug requests via [[REST API | To test and debug requests via [[REST API]], use the [https://www.postman.com/ Postman] service. Follow these steps for a successful connection. | ||
*Invoke the import of Planfix REST API into Postman: | *Invoke the import of Planfix REST API into Postman: | ||
| Line 14: | Line 14: | ||
*Paste the link from the Planfix REST API documentation page and click the "Continue" button: | *Paste the link from the Planfix REST API documentation page and click the "Continue" button: | ||
< nowiki > https://help.planfix.com/restapidocs/swagger.json</nowiki > | <nowiki > https://help.planfix.com/restapidocs/swagger.json</nowiki> | ||
https://s.pfx.so/pf/yo/Z7ngNr.jpg | https://s.pfx.so/pf/yo/Z7ngNr.jpg | ||
| Line 32: | Line 32: | ||
Please note that each Planfix account has its address for API requests, which looks like this | Please note that each Planfix account has its address for API requests, which looks like this | ||
< nowiki > https://account_domain/rest</nowiki > | <nowiki > https://account_domain/rest</nowiki> | ||
https://s.pfx.so/pf/TJ/Df8rmn.jpg | https://s.pfx.so/pf/TJ/Df8rmn.jpg | ||
Latest revision as of 08:18, 30 January 2024
To test and debug requests via REST API, use the Postman service. Follow these steps for a successful connection.
- Invoke the import of Planfix REST API into Postman:
- Paste the link from the Planfix REST API documentation page and click the "Continue" button:
https://help.planfix.com/restapidocs/swagger.json
- Then click the "Import" button in the new window:
- Specify the authorization token from the Planfix REST API section:
- Specify the address for API requests and save the settings:
Please note that each Planfix account has its address for API requests, which looks like this
https://account_domain/rest
Now, everything is ready for testing and debugging requests in Postman.
Additional information