I don’t know the correct terms but I have been tasked with documenting a 3rd party’s API so we can use it internally.
I’m able to get normal end points done using an URL variable and query string parameters
{{url}}/company?FEIN=
But how do you set it up when part of the path is a variable?
{{url}}/company/{CompanyKey}/planroom/file?CompanyLocationKey=
CompanyKey is not a single value but will change each request - so I didn’t think a variable like URL would be appropriate. Its not a query string parameter like CompanyLocationKey.
I’ve seen this pattern in other APIs but haven’t used Postman to document them so not sure how to set them up. Any suggestions?
You should write for their documentation pages because this was what I needed but the docs SUCKED !! —>
Path parameters form part of the request URL, and are referenced using placeholders preceded by : as in the following example: /customer/:id
-----path parameters section doesn’t even show up until you add the “:var”
Clear like caught in ceiling fan.
Thanks bro this helped !