Difference between revisions of "Getting Started"

From Enterprise Help
Jump to: navigation, search
Line 1: Line 1:
A [http://enterprisehelp.fishbowl.com/Administrators Site Administrator] or an ##'''API User##''' can access the Fishbowl Enterprise API using a Client ID, Client Secret, and Access Token. The following steps will show you how to create an '''API User''', generate the '''Client ID''' & '''Client Secret''', and how to retrieve an '''Access Token'''.
+
A '''Client''' can access a '''User’s Account''' with the '''Resource Server''' using a '''Client ID''', '''Client Secret''', '''Access Token''', and '''Refresh Token'''. The following steps will show you how to create an '''API User''', generate the '''Client ID''', '''Client Secret''', and'''Authorization Token'''; and then, use that information to retrieve an '''Access Token '''and '''Refresh Token.'''
  
 +
== '''Role Definitions'''<br/> ==
  
 +
*The '''Resource Owner''' or “'''User'''” is the Fishbowl customer who is giving access to their account.
 +
*The '''Client''' is the application that is attempting to get access to the User Account.
 +
*The '''Resource Server''' is the Fishbowl API Server used to access the User Account.<br/>
  
<span style="font-size:large">'''Creating an API User'''</span>
+
== '''Creating an API User'''<br/> ==
 
+
To create an API User you will first need to log into Enterprise as a&nbsp;[http://enterprisehelp.fishbowl.com/Administrators Site Administrator];&nbsp;then navigate to the '''Administrators '''page found under '''Settings'''.
+
 
+
[[http://enterprisehelp.fishbowl.com/images/6/62/AdminLink.png http://enterprisehelp.fishbowl.com/images/6/62/AdminLink.png]]
+
 
+
<br/>Then click '''Add New Administrator&nbsp;'''at the top of the page.
+
 
+
[http://enterprisehelp.fishbowl.com/images/f/f9/NewAdminLink.png http://enterprisehelp.fishbowl.com/images/f/f9/NewAdminLink.png]
+
 
+
 
+
 
+
FIll out the '''Username''', '''Password''', and '''Email Address''' fields with the desired credentials. Then check the box located under '''API User''' and click&nbsp;'''Save'''.
+
 
+
<br/>[http://enterprisehelp.fishbowl.com/images/6/61/NewAdminForm.png http://enterprisehelp.fishbowl.com/images/6/61/NewAdminForm.png]
+
 
+
 
+
 
+
<br/>''Note: If you are the&nbsp;[http://enterprisehelp.fishbowl.com/Administrators Site Administrator]&nbsp;for multiple Enterprise Sites you will need to use the '''Add Site Dropdown&nbsp;'''to select the site(s)&nbsp;the user will to access need access to and then check the API User box for each.'''''<b>&nbsp;</b>'''
+
<div><div><br/></div><div><br/></div><div><br/></div><div>
+
----
+
 
+
 
+
 
+
 
+
 
+
<br/>'''Client ID And Client Secret''' Fishbowl will provide you with a Client ID and a Client Secret. The Client ID is considered public information, and is used to build login URLs. The Client Secret must be kept confidential.
+
 
+
 
+
 
+
 
+
 
+
<br/><span style="font-size:large">'''Generating the Client ID & Client Secret'''</span>
+
 
+
<br/>To generate the '''Client ID '''& '''Client Secret''' you will first need to log into Enterprise as a&nbsp;[http://enterprisehelp.fishbowl.com/Administrators Site Administrator];&nbsp;then navigate to the&nbsp;'''Administrators&nbsp;'''page found under&nbsp;'''Settings'''.
+
 
+
[http://enterprisehelp.fishbowl.com/images/6/62/AdminLink.png http://enterprisehelp.fishbowl.com/images/6/62/AdminLink.png]
+
 
+
<br/>On the '''Administrators '''page find the user you intend to generate the Client ID & Client Secret for, and click the '''Paddlock Icon'''&nbsp;next to their user name&nbsp;to access&nbsp;'''Security Settings'''.
+
 
+
 
+
 
+
[[File:PaddlockScreen.png|left|paddlockScreen.png]]
+
 
+
Now click the Register New Application button to generate the Client ID & Client Secret.
+
 
+
<br/>[[File:RegisterNewApp.png|left|RegisterNewApp.png]]
+
 
+
<br/>You now have the Client ID & Secret needed to retrieve your access token.
+
 
+
 
+
 
+
[[File:ClientSecret.png|left|ClientSecret.png]]
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
----
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
<br/>'''Retrieve Access Token'''
+
 
+
TBD
+
 
+
 
+
<div><br/></div><div><br/></div><div>
+
----
+
<br/></div>
+
<span style="font-size:x-large">'''OLD INFO'''</span>
+
 
+
 
+
 
+
If you're a [[Administrators|Site Administrator]] for one or more sites, follow these steps to be up-and-running with the Fishbowl Enterprise API in just minutes:
+
 
+
 
+
 
+
#From the Manage Administrators screen, click the pencil icon to edit your own Administrator record. Then check the "API User" checkbox and click the "Save" button.
+
#In a web browser, paste this URL into the address bar and hit Enter: [https://services.fishbowl.com/api/odata/v1/Sites https://services.fishbowl.com/api/odata/v1/Sites]
+
#The browser will prompt you to enter your username and password. Use your Fishbowl administrator credentials (the same one you use to log in to Fishbowl Enterprise).[[File:Embim1.jpg|center|Embim1.jpg]]
+
#Depending on the web browser you're using, you might receive a prompt asking you if you'd like to open or save a file, in which case you should choose "Open":
+
 
+
<br/>[[File:Embim1.jpg|center|Embim1.jpg]]
+
 
+
 
+
 
+
:...or the browser might display the raw data in [http://en.wikipedia.org/wiki/JSON JSON] format:
+
 
+
 
+
 
+
::{
+
:::"odata.metadata":"[https://services.fishbowl.com/API/odata/v1/123456/$metadata#Sites https://services.fishbowl.com/API/odata/v1/123456/$metadata#Sites]","value":[
+
::::{
+
:::::"SiteID":"4294967274","Name":"Main Street Grill","SiteGUID":"8d1405c0-e704-4171-a285-::da591896b0c6","WebDomainName":"mainstreetgrill.fbmta.com","MailDomainName":"mainstreetgrill.fbmta.com"
+
::::},{
+
:::::"SiteID":"4294967289","Name":"Main Street Grill - Corporate","SiteGUID":"7c4bc04f-6dd2-4f4a-83f8-::bb298dd6ef32","WebDomainName":"mainstreetgrillcorp.fbmta.com","MailDomainName":"mainstreetgrill.fbmta.com"
+
::::}
+
::}<br/>
+
::<br/>
+
 
+
::
+
<br/>That's it: you've made a successful API request to retrieve a list of Sites for which you're authorized as an API User.</div></div>
+

Revision as of 17:45, 12 May 2015

A Client can access a User’s Account with the Resource Server using a Client ID, Client Secret, Access Token, and Refresh Token. The following steps will show you how to create an API User, generate the Client IDClient Secret, andAuthorization Token; and then, use that information to retrieve an Access Token and Refresh Token.

Role Definitions

  • The Resource Owner or “User” is the Fishbowl customer who is giving access to their account.
  • The Client is the application that is attempting to get access to the User Account.
  • The Resource Server is the Fishbowl API Server used to access the User Account.

Creating an API User