Revision as of 15:21, 10 August 2023

The Fishbowl 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 are looking for a way to view data, import data, and perform basic functions. This can all be done without the API.
1. All of the database tables can be viewed, queried, and exported from the Data module.
2. New data can be imported and basic order functions can be performed using Imports and Exports.
3. 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.
4. The Schedule module can automatically email reports, run data queries, or import local files or 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 on 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 on-premise, or in the cloud?
- Typically, Fishbowl Advanced is installed on your local computer as an on-premise solution, but the ports can be opened up to allow you to connect the Fishbowl Client (or an integrated app) 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.

How do I access the documentation for the REST API calls
- 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.
- 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.

Are there other versions of the API?
- Previous versions of the API (v1 and v2) used a socket connection. They still work, but they are not recommended. If needed, you can download the documentation and examples for v1 and v2 by clicking here.

@@ Line 3: / Line 3: @@
 =FAQs=
 * '''What alternatives are there to using the API?'''
-** We have found that most customers are looking for a way to view data, import data, and perform basic functions. This can all be done ''without'' the API.
+** Many customers are looking for a way to view data, import data, and perform basic functions. This can all be done ''without'' the API.
 *# All of the database tables can be viewed, queried, and exported from the {{Module|Data}}.
 *# New data can be imported and basic order functions can be performed using [[Imports and Exports]].
@@ Line 9: / Line 9: @@
 *# The {{Module|Schedule}} can automatically email reports, run data queries, or import local files or files on a server, such as an FTP server.
-* '''Are there multiple versions of the API?'''
+* '''How do I connect to the API?'''
-** Yes. We recommend using v3. If needed, you can download the documentation and examples for v1, and v2 by clicking here.
+* The API is automatically installed when you install the Fishbowl server. It can be accessed on 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.
-* '''What are the major differences between the 3 versions of the API'''
+* '''Is Fishbowl Advanced on-premise, or in the cloud?'''
-** v1 uses a socket connection to send XML.
+** Typically, Fishbowl Advanced is installed on your local computer as an on-premise solution, but the ports can be opened up to allow you to connect the Fishbowl Client (or an integrated app) from anywhere in the world.
-** v2 uses a socket connection to send JSON.
-** v3 is a JSON REST API that runs on your Fishbowl Server computer. It can be accessed locally or configured to allow connections from anywhere in the world.
-* '''If Fishbowl Advanced on-premise, or in the cloud?'''
-** Typically, Fishbowl Advanced is installed on your local computer as an on-premise solution, but the ports can be opened up to allow you to connect 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.
 ** [https://help.fishbowlonline.com/s/article/Drive-Getting-Started Fishbowl Drive] is a similar, but separate product that is 100% web based and hosted in the cloud with its own API.
@@ Line 30: / Line 25: @@
 ** 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: '''<nowiki>192.168.29.37:80/apidocs</nowiki>'''
 ** An example of the API documentation can be accessed [https://fishbowlhelp.com/files/apidocs/introduction.html here].
+* '''Are there other versions of the API?'''
+** Previous versions of the API (v1 and v2) used a socket connection. They still work, but they are not recommended. If needed, you can download the documentation and examples for v1 and v2 by clicking here.