Collective[i] API Set-Up Guide.

Setup Steps

  1. Administrator of the client (“User”) logs in to Collective[i]

  2. User opens the dropdown menu in the top right corner and selects “Developer”

    • On the first time through, User is taken to the API License Agreement  page

  3. User agrees to the API License Agreement

    • User is then taken to the Developer Panel with an empty dashboard

  4. Initially, User is in the “Testing” version of the platform

    • To retrieve the client’s actual data, User needs to complete the payment process via Stripe

  5. User clicks “Production” tab in the dashboard

    • User is taken to a Stripe payment page

    • Upon successful payment, User taken back to the dashboard

  6. User selects the “Production environment” tab and clicks the API Keys button in the left pane

  7. User clicks the “Create a new API Key” button, enters a name for the key and clicks “Create”

    • Note: the created API Key must be copied and stored by the client. It will not display anywhere after this step.

  8. From here, the client has an API key that can be used to access Collective[i]’s APIs to retrieve client’s own data

Retrieval Steps

  1. Upon successful creation of the API key, a developer for the same client can complete steps 1-3 from the Setup Steps

  2. A Collective[i] engineer will configure the developer to have access to the ‘Production’ version of the platform

  3. The developer can take the API key as a basic authorization header in their requests to the endpoint: `/api/v1/{client_id}/insights/forecast` 

    • Collective[i] will provide the initial endpoint 

If successful, the developer should receive a response that contains a payload that looks like:

If unsuccessful, an error will show up in the dashboard with a status code and message explaining the error.

Note that certain errors, such as invalid path, may not make it to the dashboard as they occur before reaching the API service.

API Specs for Developers

To Collective[i] Public API Specs 

Still have questions? Contact us. We’re here to help.

{
  "client_name": "test",
  "client_id": "123e4567-e89b-12d3-a456-426614174000",
  "revenue_units": "USD",
  "forecast_window": {
    "month": {
      "predicted_revenue": 10000,
      "change_percentage": 0.05
    },
    "quarter": {
      "predicted_revenue": 30000,
      "change_percentage": -0.3
    },
    "year": {
      "predicted_revenue": 120000,
      "change_percentage": 0.2
    }
  }
}