Spreadapi
Source code
  • Introduction
  • Setup
  • Usage
    • API Reference
  • Examples
    • Sign-up form
    • 404 errors reporting
  • Contact
Powered by GitBook
On this page

Usage

API design

SpreadAPI has to deal with limitations imposed by the Google Apps Script engine. There are two limitations that make running a state-of-art REST API impossible in this environment:

  1. Each script can respond only on one hardcoded URL. It can't handle request comming at subpaths like /users or /transactions/15.

  2. Only GET and POST methods are supported.

Due to the these limitations the SpreadAPI script handles only POST requests on a single URL. The actual HTTP method and resource path are provided in request body as shown in the example below:

{
    "method": "GET",
    "sheet": "users"
}

Other parameters (like payload for POST and PUT requests) are provided as additional fields in the request body:

{
    "method": "PUT",
    "sheet": "users",
    "id": "2",
    "payload": {
        "firstname": "John",
        "lastname": "Smith"
    }
}

For each request Google App Scripts first returns status 302 (redirect). To get result of your request you need to make a follow-up GET request (without any payload) to the URL shared in the Location response headers. Some libraries do this automatically, but that's not always the case.

PreviousSetupNextAPI Reference

Last updated 1 year ago

For more information on this topic visit documentation page.

API Reference