Difference between revisions of "API"

From Enterprise Help
Jump to: navigation, search
Line 1: Line 1:
API Intro Page
+
'''Intro—should include an overview of the QS and the API and why a client would need one vs. the other)'''
  
  
<pre>
 
Some Text
 
  
</pre>
+
*[[The “Quick Subscribe/Unsubscribe” Process]] '''(done)'''
 +
*[[Fishbowl Enterprise API]] '''(done)'''
 +
 
 +
:*[[Getting Started]] '''(details Basic Auth--should we delete/revise?)'''
 +
:*[[Security]] '''need content'''
 +
::*[[OAuth]] '''DRAFT--incomplete, needs work'''
 +
:*[[OData]] '''need content'''
 +
::*[[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'''
 +
:*[[Fishbowl Enterprise Partner API]] '''Needs review--is it up to date to match what is in production?'''
 +
 
 +
 
 +
 
 +
'''Use cases not yet documented:'''
 +
 
 +
::*What are the existing InputSource field values
 +
::*How to unsubscribe a member
 +
::*What profile fields should be displayed to members on an eclub join form on my website
 +
::*How to send a single message to a member (exiting mailing)
 +
::*How do I know what storecode to use when adding or updating a member record
 +
::*How do I see a list of all Stores for a site?
 +
:::*Which ones are open/closed, etc
 +
::*How do I know which stores to show on an eclub join form on my website? And what should I show on my website?
 +
:::*Show display values, add StoreCode to member records

Revision as of 15:03, 8 May 2015

Intro—should include an overview of the QS and the API and why a client would need one vs. the other)


  • 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


Use cases not yet documented:

  • What are the existing InputSource field values
  • How to unsubscribe a member
  • What profile fields should be displayed to members on an eclub join form on my website
  • How to send a single message to a member (exiting mailing)
  • How do I know what storecode to use when adding or updating a member record
  • How do I see a list of all Stores for a site?
  • Which ones are open/closed, etc
  • How do I know which stores to show on an eclub join form on my website? And what should I show on my website?
  • Show display values, add StoreCode to member records