'%20stroke='url(%23em)'/%3e%3cellipse%20cx='30'%20cy='34'%20rx='26'%20ry='20'%20fill='url(%23gm)'/%3e%3cpath%20d='M12.5%2013.00L52.5%2021.74L52.5%2024.33L12.5%2017.60Z'%20fill='url(%23lm)'/%3e%3crect%20x='14.20'%20y='19.29'%20width='6.60'%20height='28.93'%20rx='1.45'%20fill='url(%23cm0)'/%3e%3crect%20x='27.00'%20y='21.24'%20width='5.60'%20height='24.81'%20rx='1.23'%20fill='url(%23cm1)'/%3e%3crect%20x='37.60'%20y='22.85'%20width='4.70'%20height='21.42'%20rx='1.03'%20fill='url(%23cm2)'/%3e%3crect%20x='46.60'%20y='24.22'%20width='4.00'%20height='18.53'%20rx='0.88'%20fill='url(%23cm3)'/%3e%3cpath%20d='M12.5%2050.00L52.5%2042.57L52.5%2044.26L12.5%2053.00Z'%20fill='%237fa3ff'%20opacity='.75'/%3e%3c/svg%3e)
PorticolGetting started
Porticol is a desktop app for sending, testing and sharing API requests. It works with no account and no network connection: what you make stays on your computer until you sign in to share it.
Install
Download the app for macOS, Windows or Linux from the download page. Porticol checks for a new version when it starts and once a day, and asks before it installs one.
The first launch
The first time Porticol opens, it offers two ways to start:
- Open the sample workspace adds requests to public test APIs over HTTP, GraphQL, WebSocket, SSE and gRPC, a run set up from a data file, a mock server and an environment that holds every address. Sending them reaches the internet.
- Start empty leaves the workspace empty.
A tour of five steps follows: the sidebar, a request, Send, the response and the runner. You can skip it at any step.
Send a request
Shortcuts here use Mod, which is Command on macOS and Ctrl on Windows and Linux.
- Press Mod+T, or choose New request in the command palette. A request opens in a new tab.
- Type a URL, such as
https://httpbin.org/get, and choose the method beside it. - Press Mod+Enter to send it.
The response appears beside the request. The workbench describes what it shows.
Save it in a collection
A collection holds folders and requests. Press Mod+S, or choose Save in the palette. A request that isn't in a collection yet asks for a name and the collection to save it in, or the name of a new one. To make an empty collection first, press Mod+N or choose New collection….
A tab with unsaved edits asks before it closes. Press Mod+W, or choose Close tab, to close the tab you are in.
The command palette
Press Mod+K to open the command palette. Type to search requests, collections, environments and history, or the name of a command. A first character narrows the search to one kind:
| Type | To search |
|---|---|
> |
Commands |
/ |
Requests |
@ |
Environments |
# |
History |
Tab moves from one kind to the next. Mod+P opens the palette on requests alone, to go to a request by name. Requests are found by name, URL, body and scripts, and history by URL.
Every command in the palette is described in these pages. Open settings, or Mod+comma, opens Settings.
Where to go next
- The workbench: the sidebar, tabs, the response, history and importing.
- Sending requests: environments, variables, scripts and auth.
- Collection runner: run a whole collection with a data file.
- Sync: sign in to share collections and environments with your team.