Difference between revisions of "API"

From Enterprise Help
Jump to: navigation, search
Line 1: Line 1:
'''Intro—should include an overview of the QS and the API and why a client would need one vs. the other)'''
+
'''What is an API?'''
  
 +
An API (Application Programming Interface) is the way in which a software application allows other software applications to interact with it. The Fishbowl Enterprise API is a web service, which is an API that allows two applications to communicate over the Internet using standard web protocols such as HTTP.
 +
 +
<br/>'''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.
 +
 +
<br/>You can call the API in response to a real-time event, such as a Member submitting a form hosted on your website, or as part of a scheduled "batch" job, such as retrieving a list of all the hard bounces generated in the past 24 hours.
 +
 +
<br/>'''Do I need to write code to use the API?'''
 +
 +
Yes. You'll need to write code that suits your unique business requirements, and you'll need to host that code on your website or on other servers under your control. Third-party software development and/or hosting providers can assist you with writing and hosting your code, but Fishbowl will not write or host your code for you.
 +
 +
<br/>'''In technical terms, what is the 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.
 +
 +
<br/>'''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.
  
  
*[[Fishbowl Enterprise API]] '''(done)'''
 
  
 
:*[[Getting Started]] '''(details Basic Auth--should we delete/revise?)'''
 
:*[[Getting Started]] '''(details Basic Auth--should we delete/revise?)'''

Revision as of 08:23, 13 May 2015

What is an API?

An API (Application Programming Interface) is the way in which a software application allows other software applications to interact with it. The Fishbowl Enterprise API is a web service, which is an API that allows two applications to communicate over the Internet using standard web protocols such as HTTP.


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.


You can call the API in response to a real-time event, such as a Member submitting a form hosted on your website, or as part of a scheduled "batch" job, such as retrieving a list of all the hard bounces generated in the past 24 hours.


Do I need to write code to use the API?

Yes. You'll need to write code that suits your unique business requirements, and you'll need to host that code on your website or on other servers under your control. Third-party software development and/or hosting providers can assist you with writing and hosting your code, but Fishbowl will not write or host your code for you.


In technical terms, what is the 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.


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.


  • OAuth DRAFT--incomplete, needs work
  • Entities needs review--does this match what is in production?
  • Actions needs review
  • API Use Cases (w/sample docs)
  • Getting Site Information Needs review--written for partner audience, not for client audience, has references to enterprise.qa.fishbowl.com
  • Getting and Creating List Needs review--written for partner audience, not for client audience, has references to enterprise.qa.fishbowl.com
  • Getting Locations Needs review--written for partner audience, not for client audience, has references to enterprise.qa.fishbowl.com
  • Adding or Updating Members Needs review--written for partner audience, not for client audience, has references to enterprise.qa.fishbowl.com
  • Getting Member Profile Fields Needs review--written for partner audience, not for client audience, has references to enterprise.qa.fishbowl.com