Skip to content

Removed paragraph linking to broken webpage #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −7
Open

Removed paragraph linking to broken webpage #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions apiary.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,12 @@ recommend you create an account specifically for use with our API.
### Creating your API client
In order to make requests on behalf of a user, the client needs to be authorized by the user.
All clients must use OAuth2.0 to connect with BOS on behalf of a BOS user.
To register a new client, login to BOS and navigate to the API app.
To register a new client, login to BOS and navigate to the API app located in Home > Settings > API.
In this area of BuildingOS you will be able to view/update/delete API clients.
You can create as many clients as you like. We recommend you create at least two, one for "production" and one for "development".
You will need to name the client, provide a description and contact email. These will be presented to the user during the authorization flow.
Once created, the BOS system will generate a clientID and secret to use during your applications authorization process.

Since the API is still in beta, there is no way to directly link to the OAuth client creation pages.
To register your OAuth client first log in to your account and then copy and paste this to the
browser URL [https://api.buildingos.com/o/applications](https://api.buildingos.com/o/applications)
Click the "New Application" button to create your OAuth client.

#### Client name
Each client you create will need a name. Typically, if you are developing an application,
you create a client to use for development, sandbox/testing, and production e.g. "My App - Development", "My App - Production", etc...
Expand Down Expand Up @@ -1553,4 +1548,4 @@ Name | Description

+ Response 200

[Notifications List][]
[Notifications List][]