Releases

Change log

Version 3.1.1

• Added Collect API including the following endpoints for events:
  • Custom events
  • Unsubscribe
  • Thing interaction
  • Thing connected
  • Consumable usage
  • Firmware upgrade started
  • Firmware upgrade completed

Version 2.1.6

Changed:

• Base API paths changed from /v1/api/management/* to /v2/api/management/copilot_connect/*.
• API parameters and responses changed from camelCase to snake_case (please refer migration guide below).

Version 2.0.9

• Management API initial release supporting:
  • Session management
  • User management
  • Thing management
  • End-user authentication

Migration guide

Migrating from 2.0.9 to 2.1.6

Session management

• Path
  • Old path : /v1/api/management/auth/token
  • New path : /v2/api/management/copilot_connect/auth/token

User API

Get all users (paginated or not)

• Path

  • Old path : /v1/api/management/users
  • New path : /v2/api/management/copilot_connect/users

• Query parameters:

  • orderBy -> order_by
  • orderDirection -> order_direction

• Response model:

  • nextPage -> next_page
  • firstName -> first_name
  • lastName -> last_name
  • createdAt -> created_at
  • updatedAt -> updated_at

• Error body:

  • errorMessage -> error_message

Get single user

• Path

  • Old path : /v1/api/management/users/{UserId}
  • New path : /v2/api/management/copilot_connect/users/{user_id}

• Query parameters:

  • orderBy -> order_by
  • orderDirection -> order_direction

• Response model:

  • firstName -> first_name
  • lastName -> last_name
  • isAnonymous -> is_anonymous
  • termsOfUseVersionApproved -> terms_of_use_version_approved
  • emailVerificationStatus -> email_verification_status
  • customSettings -> custom_settings
  • associatedThings -> associated_things
    • physicalId -> physical_id
    • firmware -> firmware_version
    • lastSeen -> last_seen_at
    • associationData -> association_data
  • createdAt -> created_at
  • updatedAt -> updated_at

• Error body:

  • errorMessage -> error_message

Thing API

Get all things (paginated or not)

• Path

  • Old path : /v1/api/management/things
  • New path : /v2/api/management/copilot_connect/things

• Request body:

  • orderBy -> order_by
  • orderDirection -> order_direction

• Response model:

  • nextPage -> next_page
  • physicalId -> physical_id
  • firmware -> firmware_version
  • lastSeen -> last_seen

• Error body:

  • errorMessage -> error_message

Get single thing:

• Path

  • Old path : /v1/api/management/things/{thingPhysicalId}
  • New path : /v2/api/management/copilot_connect/things/{thing_physical_id}

• Request body:

  • orderBy -> order_by
  • orderDirection -> order_direction

• Response model:

  • nextPage -> next_page
  • physicalId -> physical_id
  • firmware -> firmware_version
  • lastSeen -> last_seen
  • statuses (no change)
    • statusValue -> status_value
  • customSettings -> custom_settings
  • associatedUsers -> associated_users
  • createdAt -> created_at
  • updatedAt -> updated_at

• Error body:

  • errorMessage -> error_message

Update single thing:

• Path

  • Old path : /v1/api/management/things/{thingPhysicalId}
  • New path : /v2/api/management/copilot_connect/things/{thing_physical_id}

• Request body:

  • firmware -> firmware_version
  • lastSeen -> last_seen
  • customSettings -> custom_settings

• Response body:

  • See response body changes for Get single thing

Authenticate end-user

• Path

  • Old path /v1/api/management/authenticate
  • New path /v2/api/management/copilot_connect/authenticate

• Request body:

  • accessToken -> access_token

• Response model:

  • isTokenValid -> is_token_valid
  • toClientResponse -> to_client_response
    • httpCode -> http_code
    • httpBody -> http_body
      • errorCode -> error_code
      • errorMessage-> error_message
  • userId -> user_id
  • userRole -> user_role

• Error body:

  • errorMessage -> error_message