Difference between revisions of "Getting Started"
From Enterprise Help
(Created page with "If you're a Site Administrator for one or more sites, follow these steps to be up-and-running with the Fishbowl Enterprise API in just minutes: #From ...") |
|||
| Line 1: | Line 1: | ||
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: | 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. | + | #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 | + | #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. | + | #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": | #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 | + | :...or the browser might display the raw data in [http://en.wikipedia.org/wiki/JSON JSON] format: |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | That's it: | + | |
| + | ::{ | ||
| + | :::"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. | ||
Revision as of 11:36, 5 May 2015
If you're a 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
- 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).
- 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":
- ...or the browser might display the raw data in JSON format:
- {
- "odata.metadata":"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"
- }
- {
- "odata.metadata":"https://services.fishbowl.com/API/odata/v1/123456/$metadata#Sites","value":[
- }
- {
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.
