Difference between revisions of "API"

From Enterprise Help
Jump to: navigation, search
 
Line 1: Line 1:
== '''API Overview'''<br/> ==
+
== '''API Overview''' ==
  
 
<br/>'''What is the Fishbowl API?'''
 
<br/>'''What is the Fishbowl API?'''
Line 7: Line 7:
 
'''What can the Fishbowl Enterprise API do for me?'''
 
'''What can the Fishbowl Enterprise API do for me?'''
  
The API allows you to create, retrieve, update, and delete many different types of data within the Fishbowl system (see the [http://enterprisehelp.fishbowl.com/Entities Entities] section for details). Many of the tasks that can be accomplished manually through the Enterprise web user interface can also be accomplished programmatically through the API: importing and exporting Member data; creating and deploying Mailings; managing Campaigns and Lists; tracking opens, clicks, and bounces; tagging Members to target in subsequent mailings; even aggregating statistical data to produce reports.
+
The API allows you to create, retrieve, update, and delete many different types of data within the Fishbowl system (see the [[Entities|Entities]] section for details). Many of the tasks that can be accomplished manually through the Enterprise web user interface can also be accomplished programmatically through the API: importing and exporting Member data; creating and deploying Mailings; managing Campaigns and Lists; tracking opens, clicks, and bounces; tagging Members to target in subsequent mailings; even aggregating statistical data to produce reports.
  
 
'''Which programming languages can I use?'''
 
'''Which programming languages can I use?'''
Line 13: Line 13:
 
RESTful web services use standard HTTP methods, so almost any modern development platform can successfully target the Fishbowl Enterprise API. Platforms such as .NET and Java for which OData client libraries are available are ideal, because those libraries simplify the development process considerably.
 
RESTful web services use standard HTTP methods, so almost any modern development platform can successfully target the Fishbowl Enterprise API. Platforms such as .NET and Java for which OData client libraries are available are ideal, because those libraries simplify the development process considerably.
  
== '''[[Getting Started|Getting Started : Credentials and Access Tokens]]'''<br/> ==
+
== '''[[Getting_Started|Getting Started : Credentials and Access Tokens]]''' ==
  
 
This section provides details on how to create an API user, get the Client ID, Client Secret and Access token in order to use the Fishbowl API.
 
This section provides details on how to create an API user, get the Client ID, Client Secret and Access token in order to use the Fishbowl API.
  
== '''[[API Info|Additional API Info]]'''<br/> ==
+
== '''[[API_Info|Additional API Info]]''' ==
  
 
== Simple Development Scenarios ==
 
== Simple Development Scenarios ==

Latest revision as of 18:03, 19 February 2020

API Overview


What is the Fishbowl API?

The Fishbowl Enterprise API is a RESTful web service that supports the OData Version 3.0 data protocol and the OAuth 2.0 security protocol.

What can the Fishbowl Enterprise API do for me?

The API allows you to create, retrieve, update, and delete many different types of data within the Fishbowl system (see the Entities section for details). Many of the tasks that can be accomplished manually through the Enterprise web user interface can also be accomplished programmatically through the API: importing and exporting Member data; creating and deploying Mailings; managing Campaigns and Lists; tracking opens, clicks, and bounces; tagging Members to target in subsequent mailings; even aggregating statistical data to produce reports.

Which programming languages can I use?

RESTful web services use standard HTTP methods, so almost any modern development platform can successfully target the Fishbowl Enterprise API. Platforms such as .NET and Java for which OData client libraries are available are ideal, because those libraries simplify the development process considerably.

Getting Started : Credentials and Access Tokens

This section provides details on how to create an API user, get the Client ID, Client Secret and Access token in order to use the Fishbowl API.

Additional API Info

Simple Development Scenarios

  1. Getting Site Information
  2. Getting & Creating Mailing Lists
  3. Getting Store Locations
  4. Getting Member Demographic Data (Profile Field Data)
  5. Adding & Updating Members
  6. Searching For Members