Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

Latest commit

 

History

History
69 lines (47 loc) · 2.42 KB

README.md

File metadata and controls

69 lines (47 loc) · 2.42 KB
Raw

🚨 🚨 🚨 Deprecated: please see Resource Guru API documentation instead

Resource Guru API

This is a REST-style API that uses serialized JSON and OAuth 2 authentication.

Making Requests

Encoding

The API expects all data to be UTF-8 encoded.

The Base URL

All requests start with the https://api.resourceguruapp.com/ base URL.

  • All requests are done via SSL.
  • All responses are in JSON.

Making a Basic Request

With the exception of Accounts all requests must be prefixed with the Account URL ID.

To make a request for all the Resources on the Example Corp account, the request URL will look something like this https://api.resourceguruapp.com/v1/example-corp/resources.

Authentication

In order to make authorized calls to Resource Guru's API, your application must first obtain an OAuth access token. To register your app go to https://developers.resourceguruapp.com.

Resource Guru implements OAuth2 with the authentication code flow.

Read our OAuth2 authentication guide to get started.

Once you have authenticated, you can get information about the authenticated user by calling GET https://api.resourceguruapp.com/v1/me. More details about the request and response are available on the endpoint page.

Rate Limiting

You can perform up to 33 requests per 10 second period on a registered application. If you exceed this limit, you'll get a 429 Rate Limit Exceeded response for subsequent requests. Check the Retry-After header to see how many seconds to wait before retrying the request.

Response Codes

  • 200 OK
  • 201 Created
  • 204 No Content
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 422 Unprocessable Entity
  • 5xx Resource Guru is having trouble

Endpoints