Project API

Staircase3D sends one HTTPS POST per click. The request body is the project directly, and the same deliveryID is added to the website link as staircalcDeliveryID when delivery is queued.

Authentication

The request uses Authorization: Bearer with the token you provide. Idempotency-Key contains the deliveryID, and X-StairCalc-Payload-Version is 1. Return any 2xx status within 15 seconds.

JSON format

{
  "schemaVersion": 1,
  "deliveryID": "uuid",
  "sentAt": "ISO-8601",
  "units": "millimeters",
  "overallDimensions": { "width": 0, "depth": 0, "height": 0 },
  "levels": [{
    "id": "uuid",
    "levelNumber": 1,
    "elevationMillimeters": 0,
    "dimensions": {
      "width": 0,
      "depth": 0,
      "floorToFloorHeight": 0
    },
    "input": { "...": "complete editable StaircaseInput" }
  }]
}

input contains the complete editable staircase input for the level. New compatible fields may be added later. Images, notes, part archives, meshes and other 3D data are not sent.