01. URL Bar
Overview of the URL Bar in the API app
The URL bar in the API app is the hub for sending, saving and modifying requests. The URL bar consists of 5 elements,
- Method selection
- URL field
- Send button (Execute)
- Save button
- Environment badges
Request Methods are used by protocols like
HTTP at the times of request to indicate the desired action that needs to be performed for a given resource. Firecamp supports several request methods that act on requests made to the API endpoint. The following methods are available for use through the dropdown in the URL bar:
- GET - The
GETmethod is used to retrieve data and should have no other effect on the data.
- POST - The
POSTmethod is used to submit an entity to the specified resource, often causing a change in state or modify the data.
- PATCH - The
PATCHmethod is used to apply partial modifications to a resource.
- PUT - The
PUTmethod replaces all current representations of the target resource with the request payload.
- DELETE - The
DELETEmethod deletes the specified resource.
- HEAD - The
HEADmethod asks for a response identical to that of a
GETrequest, but without the response body.
- OPTION - The
OPTIONdescribes the communication options for the target resource.
- PURGE - The
PURGEis used for removing cached files from the server, but can be used for removing anything related to caching.
- LINK - The
LINKmethod adds meta-information (Object header information) to an object, without modifying the object's content.
- UNLINK - The
UNLINKmethod deletes meta-information about an object. Only headers exactly matching the headers given are removed.
You can make a selection of your desired Request Method from the
Quick Method Selection section availabe in the body tab of
The API endpoint can be specified in the URL field. This is the endpoint on which the request will be made when the
Send button is clicked.
An API endpoint is a unique URL where requests sent by one program are answered and data in form of objects or collections of objects are returned from where the resource lives (Databases). In Firecamp, the URL bar can be used to enter API endpoints with request methods attached to it. API endpoints facilitate the interaction of one system with another system that takes care of the processing and storage of data.
Send button in the URL bar executes/sends your request to the endpoint specified in the URL field with the parameters you configured.
Save button in the URL bar saves your request to the project/module for future use by you or your team. Learn more about Projects in Firecamp and Steps to save your request in Firecamp.
Project environment snippets (if working inside a project) can be accessed from the URL bar through the dropdown list. You can toggle between different environments or create new ones as per the use-case. Learn more about Environment Snippets.