Optibus Driver App Notifications API

The Driver App Notifications API from Optibus — 1 operation(s) for driver app notifications.

OpenAPI Specification

optibus-driver-app-notifications-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Optibus Operations Driver Absences Driver App Notifications API
  version: 2.8.17
  description: '**Welcome to the Optibus Operations API documentation!**


    Optibus Operations is a cloud-based software solution that enables public transport providers to optimize their operations, planning, and scheduling. Our API provides programmatic access to Optibus Operations'' functionality, allowing you to integrate it with your own applications and systems.



    '
  license:
    name: Optibus Ltd, All rights reserved
  contact: {}
servers:
- url: https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co
  description: Contact your Optibus Customer Success Manager for the actual baseURL and API credentials to use.
tags:
- name: Driver App Notifications
paths:
  /driver-app/notifications-custom-action-public-key:
    get:
      operationId: GetPublicKey
      responses:
        '200':
          description: Public key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDriverAppNotificationsCustomActionPublicKeyResponse'
      description: 'Returns the public key that can be used to verify the payloads attached to URLs

        opened via a custom action attached to a notification received in the Optibus Driver App.


        No authentication is required to access this endpoint.'
      summary: Fetch driver app notifications custom action public key
      tags:
      - Driver App Notifications
      security: []
      parameters: []
components:
  schemas:
    GetDriverAppNotificationsCustomActionPublicKeyResponse:
      properties:
        publicKeyType:
          type: string
          description: The type of the public key, currently always `RSA_2048`
        publicKey:
          type: string
          description: The public key in PEM format
      required:
      - publicKeyType
      - publicKey
      type: object
      description: 'Response body containing the public key that can be used to verify the payloads attached to

        URLs opened via a custom action attached to a notification received in the Optibus Driver App.'
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
x-tagGroups:
- name: General API Info
  tags:
  - Authentication
  - Versioning
- name: Use case guides
  tags:
  - HR System Integration Guides
  - Fleet Management System Integration Guides
  - Operational Plan Query Guides
  - Custom Driver App Notification Action Guide
- name: Client preferences
  tags:
  - Preferences
- name: Resource Management
  tags:
  - Regions
  - Drivers
  - Driver Absences
  - Driver Employment Periods
  - Driver Custom Attributes
  - Driver Groups
  - Vehicles
  - Vehicle Downtimes
  - Vehicle Custom Attributes
- name: Operations Management
  tags:
  - Roster
  - Operational Plan
  - Tasks
  - Stops
  - Signing Times
- name: Work & Payroll
  tags:
  - Work Entities
  - Payroll
  - Statistics
- name: Private Hires
  tags:
  - Private Hires
- name: Driver App Integration
  tags:
  - Driver App Notifications
- name: Event Webhooks
  tags:
  - Event Webhooks
- name: Data Ingestion
  tags:
  - Tacho Ingestion
- name: Deprecated API Endpoints
  tags:
  - Drivers (Deprecated)
  - Vehicles (Deprecated)
  - Operational Plan (Deprecated)
- name: Changelog
  tags:
  - Changelog