Asteroid Core Backend - OpenAPI ドキュメント

以下は Asteroid Core（最新版）の OpenAPI スキーマです。お使いの環境でのスキーマは ${EndpointBaseUrl}/doc を参照してください。

運用・開発手順については「エンジニアガイド > API/型生成」も参照ください。

v1.0.0

Asteroid Core API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Authentication

Operations

POST/auth/loginPOST/auth/refreshPOST/auth/logout

---

User login

POST

/auth/login

Request Body

application/json

{

"login": "admin",

"password": "admin123"

}

Responses

Login successful

Content-Type

application/json

{

"accessToken": "string",

"refreshToken": "string",

"id": "string",

"login": "string",

"displayName": "string",

"roles": [

"string"

],

"officeCode": "string"

}

POST

/auth/login

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Refresh access token

POST

/auth/refresh

Request Body

application/json

{

"refreshToken": "refresh-token-here"

}

Responses

Token refreshed successfully

Content-Type

application/json

{

"accessToken": "string",

"refreshToken": "string"

}

POST

/auth/refresh

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

User logout

POST

/auth/logout

Authorizations

Responses

Logout successful

Content-Type

application/json

{

"message": "string"

}

POST

/auth/logout

Playground

Samples

cURL

JavaScript

PHP

Python

---

Default

Operations

POST/users

---

新規ユーザーを作成

POST

/users

Request Body

application/json

{

"login": "string",

"password": "string",

"displayName": "string",

"officeId": "string",

"roles": [

"string"

]

}

Responses

作成されたユーザー

Content-Type

application/json

{

"id": "string",

"login": "string",

"displayName": "string",

"officeId": "string",

"createdAt": "string",

"updatedAt": "string"

}

POST

/users

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Offices

Operations

GET/officesPOST/offices

---

オフィス一覧を取得

GET

/offices

Responses

オフィス一覧

Content-Type

application/json

{

"data": [

{

"id": "string",

"name": "string",

"officeCode": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/offices

Playground

Samples

cURL

JavaScript

PHP

Python

---

新規オフィスを作成

POST

/offices

Request Body

application/json

{

"name": "string",

"officeCode": "string"

}

Responses

作成されたオフィス

Content-Type

application/json

{

"id": "string",

"name": "string",

"officeCode": "string",

"createdAt": "string",

"updatedAt": "string"

}

POST

/offices

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Roles

Operations

GET/rolesPOST/roles

---

ロール一覧を取得

GET

/roles

Parameters

Query Parameters

officeId

Typestring

Format"uuid"

Responses

ロール一覧

Content-Type

application/json

{

"data": [

{

"id": "string",

"name": "string",

"officeId": "string",

"permissions": [

"string"

],

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/roles

Playground

Variables

Key

Value

officeId

Samples

cURL

JavaScript

PHP

Python

---

新規ロールを作成

POST

/roles

Request Body

application/json

{

"name": "string",

"officeId": "string",

"permissions": [

"string"

]

}

Responses

作成されたロール

Content-Type

application/json

{

"id": "string",

"name": "string",

"officeId": "string",

"permissions": [

"string"

],

"createdAt": "string",

"updatedAt": "string"

}

POST

/roles

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

PNR

Operations

GET/pnrPOST/pnrGET/pnr/{pnrCode}

---

List PNRs

GET

/pnr

Authorizations

Parameters

Query Parameters

officeId

Typestring

Format"uuid"

status

Typestring

limit

Typestring

Default20

offset

Typestring

Default0

Responses

PNR list

Content-Type

application/json

{

"data": [

],

"total": 0,

"limit": 0,

"offset": 0

}

GET

/pnr

Playground

Variables

Key

Value

officeId

status

limit

offset

Samples

cURL

JavaScript

PHP

Python

---

Create a new PNR

POST

/pnr

Authorizations

Request Body

application/json

{

"passengers": [

{

"title": "string",

"firstName": "string",

"lastName": "string",

"dateOfBirth": "string",

"passportNumber": "string",

"nationality": "string",

"email": "string",

"phone": "string"

}

],

"bookings": [

{

"flightId": "string",

"passengerIndex": 0,

"seatNumber": "string",

"bookingClass": "string",

"fare": 0

}

],

"remarks": "string"

}

Responses

PNR created successfully

Content-Type

application/json

{

"id": "string",

"pnrCode": "string",

"status": "string",

"totalAmount": 0,

"currency": "string",

"createdById": "string",

"officeId": "string",

"createdAt": "string",

"updatedAt": "string",

"remarks": "string",

"passengers": [

],

"bookings": [

]

}

POST

/pnr

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Get PNR by code

GET

/pnr/{pnrCode}

Authorizations

Parameters

Path Parameters

pnrCode*

Typestring

Required

Min Length1

Responses

PNR found

Content-Type

application/json

{

"id": "string",

"pnrCode": "string",

"status": "string",

"totalAmount": 0,

"currency": "string",

"createdById": "string",

"officeId": "string",

"createdAt": "string",

"updatedAt": "string",

"remarks": "string",

"passengers": [

],

"bookings": [

],

"office": "string",

"createdBy": "string"

}

GET

/pnr/{pnrCode}

Playground

Variables

Key

Value

pnrCode*

Samples

cURL

JavaScript

PHP

Python

---

Flights

Operations

GET/flightsPOST/flightsGET/flights/{id}PUT/flights/{id}DELETE/flights/{id}

---

List flights

GET

/flights

Authorizations

Parameters

Query Parameters

departureAirport

Typestring

arrivalAirport

Typestring

departureDate

Typestring

airline

Typestring

status

Typestring

limit

Typestring

Default20

offset

Typestring

Default0

Responses

Flight list

Content-Type

application/json

{

"data": [

{

"id": "string",

"flightNumber": "string",

"airline": "string",

"departureAirport": "string",

"arrivalAirport": "string",

"departureTime": "string",

"arrivalTime": "string",

"departureTz": "string",

"arrivalTz": "string",

"aircraftType": "string",

"status": "string",

"createdAt": "string",

"updatedAt": "string"

}

],

"total": 0,

"limit": 0,

"offset": 0

}

GET

/flights

Playground

Variables

Key

Value

departureAirport

arrivalAirport

departureDate

airline

status

limit

offset

Samples

cURL

JavaScript

PHP

Python

---

Create a new flight

POST

/flights

Authorizations

Request Body

application/json

{

"flightNumber": "string",

"airline": "string",

"departureAirport": "string",

"arrivalAirport": "string",

"departureTime": "string",

"arrivalTime": "string",

"departureTz": "string",

"arrivalTz": "string",

"scheduleType": "charter",

"pattern": {

"kind": "string",

"daysOfWeek": [

0

],

"startDate": "string",

"endDate": "string",

"departureLocalTime": "string",

"arrivalLocalTime": "string",

"tz": "string"

},

"aircraftType": "string",

"aircraftTypeId": "string",

"aircraftId": "string",

"operatingCarrierId": "string",

"codeshares": [

{

"carrierId": "string",

"code": "string"

}

],

"status": "Scheduled"

}

Responses

Flight created successfully

Content-Type

application/json

{

"id": "string",

"flightNumber": "string",

"airline": "string",

"departureAirport": "string",

"arrivalAirport": "string",

"departureTime": "string",

"arrivalTime": "string",

"departureTz": "string",

"arrivalTz": "string",

"aircraftType": "string",

"status": "string",

"createdAt": "string",

"updatedAt": "string",

"displayFlightNumber": "string",

"codeshareNumbers": [

"string"

]

}

POST

/flights

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Get flight details

GET

/flights/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Responses

Flight details

Content-Type

application/json

{

"id": "string",

"flightNumber": "string",

"airline": "string",

"departureAirport": "string",

"arrivalAirport": "string",

"departureTime": "string",

"arrivalTime": "string",

"departureTz": "string",

"arrivalTz": "string",

"aircraftType": "string",

"status": "string",

"createdAt": "string",

"updatedAt": "string",

"bookings": [

]

}

GET

/flights/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

Update flight information

PUT

/flights/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Request Body

application/json

{

"status": "string",

"aircraftType": "string",

"aircraftTypeId": "string",

"aircraftId": "string",

"departureTime": "string",

"arrivalTime": "string",

"departureTz": "string",

"arrivalTz": "string"

}

Responses

Flight updated successfully

Content-Type

application/json

{

"id": "string",

"flightNumber": "string",

"airline": "string",

"departureAirport": "string",

"arrivalAirport": "string",

"departureTime": "string",

"arrivalTime": "string",

"departureTz": "string",

"arrivalTz": "string",

"aircraftType": "string",

"status": "string",

"createdAt": "string",

"updatedAt": "string"

}

PUT

/flights/{id}

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

Delete a flight

DELETE

/flights/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Responses

Flight deleted

DELETE

/flights/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

Airlines

Operations

GET/airlinesPOST/airlines

---

List airlines

GET

/airlines

Authorizations

Parameters

Query Parameters

q

Typestring

limit

Typestring

offset

Typestring

Responses

OK

Content-Type

application/json

{

"data": [

]

}

GET

/airlines

Playground

Variables

Key

Value

q

limit

offset

Samples

cURL

JavaScript

PHP

Python

---

Create or update airline

POST

/airlines

Authorizations

Request Body

application/json

{

"id": "string",

"iata2": "string",

"icao3": "string",

"numericCode": "string",

"name": "string",

"country": "string",

"isGroup": true,

"groupPriority": 0

}

Responses

OK

Content-Type

application/json

"string"

POST

/airlines

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

AircraftTypes

Operations

GET/aircraft-typesPOST/aircraft-typesGET/aircraft-types/{id}PUT/aircraft-types/{id}DELETE/aircraft-types/{id}

---

List aircraft types

GET

/aircraft-types

Authorizations

Responses

Aircraft types list

Content-Type

application/json

{

"data": [

]

}

GET

/aircraft-types

Playground

Samples

cURL

JavaScript

PHP

Python

---

Create aircraft type

POST

/aircraft-types

Authorizations

Request Body

application/json

{

"code": "string",

"name": "string",

"seatMap": "string"

}

Responses

Created

Content-Type

application/json

"string"

POST

/aircraft-types

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Get aircraft type by id

GET

/aircraft-types/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Responses

Found

Content-Type

application/json

"string"

GET

/aircraft-types/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

Update aircraft type

PUT

/aircraft-types/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Request Body

application/json

{

"code": "string",

"name": "string",

"seatMap": "string"

}

Responses

Updated

Content-Type

application/json

"string"

PUT

/aircraft-types/{id}

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

Delete aircraft type

DELETE

/aircraft-types/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Responses

Deleted

DELETE

/aircraft-types/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

Aircraft

Operations

GET/aircraftPOST/aircraftDELETE/aircraft/{id}

---

List aircraft

GET

/aircraft

Authorizations

Responses

Aircraft list

Content-Type

application/json

{

"data": [

]

}

GET

/aircraft

Playground

Samples

cURL

JavaScript

PHP

Python

---

Create aircraft

POST

/aircraft

Authorizations

Request Body

application/json

{

"code": "string",

"name": "string",

"typeId": "string"

}

Responses

Created

Content-Type

application/json

"string"

POST

/aircraft

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Delete aircraft

DELETE

/aircraft/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Responses

Deleted

DELETE

/aircraft/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

Fares

Operations

GET/fares/basesPOST/fares/basesDELETE/fares/bases/{id}GET/fares/adjustmentsPOST/fares/adjustmentsDELETE/fares/adjustments/{id}GET/fares/quote

---

List base fares

GET

/fares/bases

Authorizations

Parameters

Query Parameters

origin

Typestring

Min Length3

Max Length3

destination

Typestring

Min Length3

Max Length3

bookingClass

Typestring

Responses

Base fares list

Content-Type

application/json

{

"data": [

]

}

GET

/fares/bases

Playground

Variables

Key

Value

origin

destination

bookingClass

Samples

cURL

JavaScript

PHP

Python

---

Create base fare

POST

/fares/bases

Authorizations

Request Body

application/json

{

"origin": "string",

"destination": "string",

"bookingClass": "Y",

"amount": 0,

"currency": "JPY",

"active": true

}

Responses

Created

POST

/fares/bases

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Delete base fare

DELETE

/fares/bases/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Responses

Deleted

DELETE

/fares/bases/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

List adjustments

GET

/fares/adjustments

Authorizations

Parameters

Query Parameters

origin

Typestring

Min Length3

Max Length3

destination

Typestring

Min Length3

Max Length3

bookingClass

Typestring

active

Typestring

Responses

Adjustments list

Content-Type

application/json

{

"data": [

]

}

GET

/fares/adjustments

Playground

Variables

Key

Value

origin

destination

bookingClass

active

Samples

cURL

JavaScript

PHP

Python

---

Create adjustment

POST

/fares/adjustments

Authorizations

Request Body

application/json

{

"origin": "string",

"destination": "string",

"bookingClass": "string",

"name": "string",

"type": "string",

"value": 0,

"applyOrder": 0,

"active": true

}

Responses

Created

POST

/fares/adjustments

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

Delete adjustment

DELETE

/fares/adjustments/{id}

Authorizations

Parameters

Path Parameters

id*

Typestring

Required

Format"uuid"

Responses

Deleted

DELETE

/fares/adjustments/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

Quote fare for route

GET

/fares/quote

Authorizations

Parameters

Query Parameters

origin*

Typestring

Required

Min Length3

Max Length3

destination*

Typestring

Required

Min Length3

Max Length3

bookingClass

Typestring

Min Length1

Default"Y"

Responses

Fare quote

Content-Type

application/json

{

"origin": "string",

"destination": "string",

"bookingClass": "string",

"currency": "string",

"base": 0,

"adjustments": [

{

"id": "string",

"name": "string",

"type": "string",

"value": 0,

"delta": 0

}

],

"total": 0

}

GET

/fares/quote

Playground

Variables

Key

Value

origin*

destination*

bookingClass

Samples

cURL

JavaScript

PHP

Python

---

Utils

Operations

GET/qr

---

Generate QR (SVG)

GET

/qr

Parameters

Query Parameters

text*

Typestring

Required

Min Length1

margin

Typestring

scale

Typestring

Responses

SVG QR

GET

/qr

Playground

Variables

Key

Value

text*

margin

scale

Samples

cURL

JavaScript

PHP

Python

---

Powered by VitePress OpenAPI