Circuit Members API

openapi: 3.2.0
info:
  title: Spoke Members API
  description: 'This is the documentation of the Spoke Public API HTTP endpoints. The Spoke

    Public API is a way for you to interact with Spoke products programmatically. # Introduction


    The API has a set of HTTP methods to operate on Spoke resources for a specific

    team. Currently, Spoke offers no programming SDKs for interacting with the Public

    API, but you can implement your own interface by calling the methods documented

    on this page. # v1 Migration Guide


    If migrating from version 0.2b to v1, please note the following changes. ### General


    1. Only `api.spoke.com` should be used for the `v1` API. 2. Webhooks requests will now only contain the `spoke-signature` header. ### Stops


    Removals:


    | Operation | 0.2b Property | v1 Property | Notes |

    | ---------- | ------------------------------- | -------------------------------- | ---------------------------------------------------------------------------- |

    | WRITE | `stop.driver` | `stop.allowedDrivers` | Drivers should now be provided as an array of `DriverIds`. |

    | READ | `stop.driverIdentifier` | `stop.allowedDrivers` | Drivers will now be returned as an array of `DriverIds`. |

    | READ | `stop.allowedDriverIdentifiers` | `stop.allowedDrivers` | Drivers will now be returned as an array of `DriverIds`. |

    | READ | `stop.etaNullReason` | `stop.eta.status` | `eta` now has a status property with the same information. |

    | READ | `stop.timeAtStopInfoNullReason` | `stop.timeAtStopInfo.status` | `timeAtStopInfo` now has a status property with the same information. |

    | READ/WRITE | `stop.circuitClientId` | `stop.clientId` | When creating or reading stops, `circuitClientId` will now be `clientId` |

    | READ | `stop.deliveryInfo.arrivedAt` | `timeAtStopInfo.value.arrivedAt` | This property is only available when `timeAtStopInfo.status === ''available''` |


    Changes:


    1. READ: `stop.eta` is now an object containing both the eta value, and additional metadata about the value. 2. READ: `stop.timeAtStopInfo` structure has changed so that the original properties are now under `timeAtStopInfo.value.*`,

    and an additional field `timeAtStopInfo.status` has been added to indicate why the info is not set. ### Plans


    Changes:


    1. Previously we would allow `Drivers` to be added even if their `Depot` did not match the plan''s `Depot`. This is no longer allowed. Non-matching `Drivers` must now have their `Depot` changed to match the target `Plan`,

    or vice versa. 2. `Driver` objects are no longer returned as part of `Plan` endpoint responses. Instead, `DriverIds` are returned and

    the associated drivers must be fetched separately (if needed). # Using the API


    This section describes how the Spoke API should be used, if you wish to see

    example implementations take a look at the API Usage

    Examples page. ## Address


    The base API address for this version of the API to be used before every

    endpoint listed here is: `https://api.spoke.com/public/v1`


    Notice the `https://` prefix, Spoke API will **not** accept plain HTTP

    requests. ## Authentication


    To use Spoke Public API endpoints you will first need to generate an API key

    for authenticating with our servers. To do this you need to go to your Spoke Dispatch settings page > Integrations

    \> API, and generate a new key there. Once you have the API key you can use it in the `Authorization` header

    either using the Basic scheme, or as a Bearer token. ### Basic Auth


    Basic Authentication is the primary authentication scheme used

    by Spoke''s API. Basic authentication typically uses a base64 encoded `username:password`

    pair, but since we only require an API key we instead structure the payload as `[yourApiKey]:[empty]`. This

    value is then base64 encoded as usual. Example with `curl`:


    ```bash

    curl "https://api.spoke.com/public/v1/plans" -u yourApiKey:

    ```


    If you did everything correctly you should see a list of your team''s plans in response

    to this request.'
  version: v1
servers:
- url: https://api.spoke.com/public/v1
security:
- BasicAuth: []
tags:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://artifacts.apis.io/getcircuit-com/openapi/getcircuit-com-members-api-openapi.yml