From b3f6e46e1735168aceb0f0395acd33d7d1a0ea32 Mon Sep 17 00:00:00 2001 From: Tim Robert-Fitzgerald Date: Thu, 23 Feb 2017 12:35:17 -0500 Subject: [PATCH] Removed paragraph linking to broken webpage The form on https://api.buildingos.com/o/applications/register/ returns an internal server error when submitted. The only way to create a new oath client is to go through the BuildingOS interface described in the above paragraph. --- apiary.apib | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/apiary.apib b/apiary.apib index 9aef864..a2694de 100644 --- a/apiary.apib +++ b/apiary.apib @@ -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... @@ -1553,4 +1548,4 @@ Name | Description + Response 200 - [Notifications List][] \ No newline at end of file + [Notifications List][]