---
openapi: 3.0.3
info:
  version: 1.0.0
  title: Third party REST API
servers:
  - url: https://partners.blablacardaily.com
tags:
  - name: Public
    description: Public search endpoints
paths:
  /1/third_party/public/search:
    get:
      operationId: getPublicRidesDeprecated
      deprecated: true
      description: Search for rides
      tags:
        - Public
      parameters:
        - "$ref": "#/components/parameters/partner-access-token"
        - "$ref": "#/components/parameters/departure-latitude"
        - "$ref": "#/components/parameters/departure-longitude"
        - "$ref": "#/components/parameters/arrival-latitude"
        - "$ref": "#/components/parameters/arrival-longitude"
        - "$ref": "#/components/parameters/departure-epoch"
        - "$ref": "#/components/parameters/departure-timedelta"
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/third-party-public-search-response"
  /2/third_party/public/search:
    get:
      operationId: getPublicRides
      description: Search for rides
      tags:
        - Public
      parameters:
        - "$ref": "#/components/parameters/partner-access-token"
        - "$ref": "#/components/parameters/departure-latitude"
        - "$ref": "#/components/parameters/departure-longitude"
        - "$ref": "#/components/parameters/arrival-latitude"
        - "$ref": "#/components/parameters/arrival-longitude"
        - "$ref": "#/components/parameters/departure-epoch"
        - "$ref": "#/components/parameters/departure-timedelta"
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/third-party-public-search-v2-response"
components:
  parameters:
    partner-access-token:
      name: access_token
      description: Access token for partner making the request
      in: query
      required: true
      schema:
        type: string
    departure-latitude:
      name: departure_latitude
      description: Passenger departure's latitude
      in: query
      required: true
      schema:
        "$ref": "#/components/schemas/latitude"
    departure-longitude:
      name: departure_longitude
      description: Passenger departure's longitude
      in: query
      required: true
      schema:
        "$ref": "#/components/schemas/longitude"
    arrival-latitude:
      name: arrival_latitude
      description: Passenger arrival's latitude
      in: query
      required: true
      schema:
        "$ref": "#/components/schemas/latitude"
    arrival-longitude:
      name: arrival_longitude
      description: Passenger arrival's longitude
      in: query
      required: true
      schema:
        "$ref": "#/components/schemas/longitude"
    departure-epoch:
      name: departure_epoch
      description: Requested passenger departure's time (unix time in seconds) - It should be between 15 minutes to 1 week from now
      in: query
      required: true
      schema:
        type: number
    departure-timedelta:
      name: departure_timedelta
      description: The timedelta around passenger departure's time (in seconds, defaults to 3600) - The resulting rides will start in the time range [departure_epoch - departure_timedelta, departure_epoch + departure_timedelta]
      in: query
      required: false
      schema:
        type: number
  schemas:
    campaign-name:
      enum:
        - INTERNAL
        - RPC
        - RPC_TEST
      type: string
    campaign-receive-result:
      properties:
        call_timestamps:
          description: The datetimes at which the calls were made
          items:
            $ref: '#/components/schemas/datetime'
          type: array
        context:
          type: object
          format: json
          description: Json string containing extra context from provider
        passenger_uuid:
          $ref: '#/components/schemas/uuid'
        status:
          type: string
          description: "the status of the fraud check, 'ok' means the user is not a fraudster. see https://github.com/blablacar/common-openapi/blob/1.1687.0/openapi/backend/care/calling-campaigns/short-distance-fraud.yml#L112"
        trip_uuid:
          $ref: '#/components/schemas/uuid'
        user_source:
          type: string
          description: represent from where the trip comes from, either 'daily' or 'klaxit'
      required:
        - call_timestamps
        - context
        - passenger_uuid
        - status
        - trip_uuid
    campaign-send-cancel-event-request:
      properties:
        campaign_name:
          $ref: "#/components/schemas/campaign-name"
        passenger_phone_number:
          $ref: "#/components/schemas/phone-number"
        passenger_uuid:
          $ref: "#/components/schemas/uuid"
        recall_count:
          description: Current number of recall
          example: 0
          type: integer
        trip_uuid:
          $ref: "#/components/schemas/uuid"
      required:
        - passenger_phone_number
        - passenger_uuid
        - recall_count
        - trip_uuid
      type: object
    campaign-send-start-event-request:
      properties:
        campaign_name:
          $ref: "#/components/schemas/campaign-name"
        driver_first_name:
          $ref: "#/components/schemas/first-name"
        driver_last_name:
          $ref: "#/components/schemas/last-name"
        driver_phone_number:
          $ref: "#/components/schemas/phone-number"
        passenger_birth_date:
          $ref: "#/components/schemas/date"
        passenger_first_name:
          $ref: "#/components/schemas/first-name"
        passenger_last_name:
          $ref: "#/components/schemas/last-name"
        passenger_phone_number:
          $ref: "#/components/schemas/phone-number"
        passenger_uuid:
          $ref: "#/components/schemas/uuid"
        pickup_date:
          $ref: "#/components/schemas/datetime"
        recall_count:
          description: Current number of recall
          example: 0
          type: integer
        trip_uuid:
          $ref: "#/components/schemas/uuid"
      required:
        - driver_first_name
        - driver_last_name
        - driver_phone_number
        - passenger_birth_date
        - passenger_first_name
        - passenger_last_name
        - passenger_phone_number
        - passenger_uuid
        - pickup_date
        - recall_count
        - trip_uuid
      type: object
    date:
      example: '2017-01-23'
      type: string
    datetime:
      description: The localized ISO8601 date and time.
      example: "2022-07-14T23:32:01+02:00"
      type: string
    first-name:
      description: First name of user.
      example: John
      type: string
    last-name:
      description: Last name of user.
      example: Doe
      type: string
    latitude:
      type: number
      example: 48.15
    longitude:
      type: number
      example: 2.35
    phone-number:
      description: The passenger phone number, it follows e.164 international standard https://en.wikipedia.org/wiki/e.164
      example: "+551155256325"
      type: string
    price:
      type: object
      required:
        - amount
        - currency
      properties:
        amount:
          description: The price that the passenger agreed to pay for this order
          example: 3.5
          type: number
        currency:
          description: The ISO 4217 code for the currency of the amount
          example: "EUR"
          type: string
    third-party-public-search-response:
      type: object
      required:
        - price
        - ride_count
        - url
      properties:
        price:
          "$ref": "#/components/schemas/price"
        ride_count:
          description: Number of rides available for those search criterion
          example: 45
          type: number
        url:
          description: Redirect url for that search
          example: "http://www.blablacardaily.com"
          type: string
    ride:
      type: object
      required:
        - id
        - duration
        - distance
        - pickup_latitude
        - pickup_longitude
        - pickup_datetime
        - dropoff_latitude
        - dropoff_longitude
        - web_url
        - departure_to_pickup_walking_time
        - dropoff_to_arrival_walking_time
        - journey_polyline
        - price
        - available_seats
      properties:
        id:
          description: id of the ride
          example: "fhsdftsdchd"
          type: string
        duration:
          description: duration of the ride, in seconds
          example: 617
          type: number
        distance:
          description: distance of the ride, in meters
          example: 5580
          type: number
        pickup_latitude:
          description: latitude of the pickup point
          example: 48.15
          type: number
        pickup_longitude:
          description: longitude of the pickup point
          example: 2.65
          type: number
        pickup_datetime:
          description: The ISO8601 date and time of departure from the pickup meeting point. tz is the one corresponding to pickup location.
          example: "1994-11-05T08:15:30-05:00"
          type: string
        dropoff_latitude:
          description: latitude of the dropoff point
          example: 48.27
          type: number
        dropoff_longitude:
          description: longitude of the dropoff point
          example: 2.65
          type: number
        web_url:
          description: the deeplink for this search in the mobile app
          example: "http://www.blablacardaily.com"
          type: string
        departure_to_pickup_walking_time:
          description: the walking time from the departure to the pickup point, in seconds
          example: 334
          type: number
        dropoff_to_arrival_walking_time:
          description: the walking time from the dropoff point to the arrival, in seconds
          example: 237
          type: number
        journey_polyline:
          description: the encoded polyline for the ride. Encoding is done using Google Encoded Polyline Algorithm [https://developers.google.com/maps/documentation/utilities/polylinealgorithm]
          type: string
        price:
          "$ref": "#/components/schemas/price"
        available_seats:
          description: the number of available seats for this ride
          example: 2
          type: number
    third-party-public-search-v2-response:
      type: array
      items:
        $ref: "#/components/schemas/ride"
    carpool-journey:
      type: object
      required:
        - id
        - duration
        - driverDepartureDate
        - driverDepartureLat
        - driverDepartureLng
        - driverArrivalLat
        - driverArrivalLng
        - webUrl
      properties:
        id:
          description: id of the ride
          example: "fhsdftsdchd"
          type: string
        duration:
          description: duration of the ride, in seconds
          example: 617
          type: number
        distance:
          description: distance of the ride, in meters
          example: 5580
          type: number
        driverDepartureDate:
          description: The timestamp of the driver departure
          example: 1655796935
          type: number
        driverDepartureLat:
          description: latitude of the driver departure point
          example: 48.15
          type: number
        driverDepartureLng:
          description: longitude of the driver departure point
          example: 2.65
          type: number
        driverArrivalLat:
          description: latitude of the driver arrival point
          example: 48.27
          type: number
        driverArrivalLng:
          description: longitude of the driver arrival point
          example: 2.65
          type: number
        webUrl:
          description: the deeplink for this search in the mobile app
          example: "http://www.blablacardaily.com"
          type: string
        type:
          type: string
          enum:
            - PLANNED
            - DYNAMIC
            - LINE
        departureToPickupWalkingTime:
          description: the walking time from the departure to the pickup point, in seconds
          example: 334
          type: number
        dropoffToArrivalWalkingTime:
          description: the walking time from the dropoff point to the arrival, in seconds
          example: 237
          type: number
        journeyPolyline:
          description: the encoded polyline for the ride. Encoding is done using Google Encoded Polyline Algorithm [https://developers.google.com/maps/documentation/utilities/polylinealgorithm]
          type: string
        price:
          "$ref": "#/components/schemas/price"
        availableSeats:
          description: the number of available seats for this ride
          example: 2
          type: number
        passengerPickupLat:
          description: latitude of the pickup point
          example: 48.15
          type: number
        passengerPickupLng:
          description: longitude of the pickup point
          example: 2.65
          type: number
        passengerDropLat:
          description: latitude of the dropoff point
          example: 48.27
          type: number
        passengerDropLng:
          description: longitude of the dropoff point
          example: 2.65
          type: number
    uuid:
      description: Unique ID.
      example: qwe-asdasd-234-dfsdfds
      type: string
  securitySchemes:
    ApiKeyAuth:
      in: header
      type: apiKey
      name: x-api-key