API

The API allows developers to integrate with Fishbowl Advanced. Fishbowl provides documentation and examples, but no official support for the API.

FAQs

• What alternatives are there to using the API?

Many customers that are interested in the API are looking for ways to import data, view tables, automate reports, or perform basic functions. This can all be done without the API.

1. The Data Import module allows files to be imported, even if the column headers don't match the Fishbowl format. This allows many external files to be imported into Fishbowl without modification.
2. New data can be imported and basic functions can be performed using Imports and Exports.
3. All of the database tables can be viewed, queried, and exported from the Data module.
4. The Schedule module can automatically email reports, run data queries, import local files, or import files on a server, such as an FTP server.

• How do I connect to the API?
  • The API is automatically installed when you install the Fishbowl server. It can be accessed anywhere from your local network, or configured to allow connections from anywhere in the world. The easiest way to get started is to use our Postman collection.

• Is Fishbowl Advanced an on-premise application, or is it in the cloud?
  • Traditionally, Fishbowl Advanced is installed on your computer as an on-premise solution that can be accessed from your local network. You can also open ports and configure the Fishbowl Server to allow connections from anywhere in the world.
  • With Fishbowl Hosted Services, we install Fishbowl Advanced for you on our high-performance servers, and configure it so that you can access it from anywhere in the world.
  • Fishbowl Drive is a similar, but separate product that is 100% web based and hosted in the cloud with its own API.

• Do I need a certificate to encrypt the API traffic?
  • Yes. For security, you must have a .JKS certificate file for the Fishbowl Server. The certificate can be self-signed or purchased online from a Certificate Authority.

• Is there another version of the API?
  • The previous version of the API uses a socket connection. It does not provide as much data validation and it is not recommended. If needed, resources for the previous version of the API can be downloaded by clicking here.

• What is the logout API call for?
  • Your license key determines the number of users that can be logged in to Fishbowl Advanced at the same time. The logout API call closes the connection so that more users can connect if needed.

Documentation

The REST API documentation is automatically installed on your Fishbowl Server. This allows you to see the documentation that is intended for your version of Fishbowl Advanced.

• To see the documentation from the Fishbowl Server computer, click the following link: http://localhost:80/apidocs
  
• To see the documentation from other computers on the network, enter the IP address of the Fishbowl Server computer, replacing 80 with your Web Port. For example: 192.168.29.37:80/apidocs
• An example of the API documentation can be accessed here.

Postman

Postman is a free application that can help you explore many APIs, including the API for Fishbowl Advanced. Follow the instructions below to get started.

1. Download Postman from this page: https://postman.com/downloads
2. Open Postman and sign in to your free account.
3. Open your Workspace, go to the Collections tab, click the Import button, and then paste the following URL: https://fishbowlhelp.com/postman.json
4. If you are not on the Fishbowl Server computer, highlight Fishbowl Advanced, click the Variables tab, and change the Current Value for the URL to the IP address of your Fishbowl Server. Then click Save.
5. Expand the Login folder and select the line that says POST Login.
   
6. Click the Body tab and change the username and password if needed. Then click Save.
7. Click the Send button near the top-right corner.
8. Open the Settings module in Fishbowl Advanced, and approve the integrated app.
9. Return to the Login request in Postman, and send it again using the keyboard shortcut (CTRL+Enter or CMD+Enter).
10. Double-click the Fishbowl Server tray icon and select the Connections tab to see your new connection. Each login request will add a new connection.
    
11. Open Postman and send a few example requests, like the ones below:
    • Expand Vendors, select the line that says GET Search Vendors, and then send the request. You should get a JSON response with your vendors.
    • Expand Inventory, select the line that says GET Inventory. and then click the Params tab. Change B201 to one of your part numbers, and then send the request.
    • Expand Parts, select the line that says GET Part Best Cost, and then click the Params tab. Notice the difference between Query Params and Path Variables.
12. Expand Login, select the line that says POST Logout, and then send the request.
13. Double-click the Fishbowl Server tray icon, select the Connections tab, and then click the Refresh button. Your connection should be removed from the list.