Difference between revisions of "Getting Started"

From Enterprise Help
Jump to: navigation, search
Line 5: Line 5:
 
*The '''Resource Owner''' or “'''User'''” is the Fishbowl customer who is giving access to their account.
 
*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 '''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/>
+
*The '''Resource Server''' is the Fishbowl API Server used to access the User Account.
  
 
== '''Creating an API User'''<br/> ==
 
== '''Creating an API User'''<br/> ==
 +
 +
#To create an API User you will first need to log into Enterprise as a&nbsp;'''Site Administrator''';&nbsp;then navigate to the&nbsp;'''Administrators&nbsp;'''page found under&nbsp;'''Settings'''.<br/><br/>[[File:AdminLink.png|border|center|AdminLink.png]]
 +
#Then click&nbsp;'''Add New Administrator&nbsp;'''at the top of the page.<br/><br/>[[File:Addadmin.png|border|center|Addadmin.png]]
 +
#Fill out the&nbsp;'''Username''',&nbsp;'''Password''', and&nbsp;'''Email Address'''&nbsp;fields with the desired credentials. Then check the box located under&nbsp;'''API User'''&nbsp;and click&nbsp;'''Save'''.
 +
 +
[[File:Apiuser.png|border|center|Apiuser.png]]
 +
 +
''Note: If you are the&nbsp;'''''<i>Site Administrator</i>'''''for multiple Enterprise Sites you will need to use the&nbsp;'''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.<br/><br/>''
 +
 +
----

Revision as of 20:50, 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

  1. To create an API User you will first need to log into Enterprise as a Site Administrator; then navigate to the Administrators page found under Settings.

    AdminLink.png
  2. Then click Add New Administrator at the top of the page.

    Addadmin.png
  3. Fill out the UsernamePassword, and Email Address fields with the desired credentials. Then check the box located under API User and click Save.
Apiuser.png

Note: If you are the Site Administratorfor multiple Enterprise Sites you will need to use the Add Site Dropdown to select the site(s) the user will to access need access to and then check the API User box for each.