Cabin Layout
Related product: Flight Happiness Index and Cabin Data.
Introduction
This document describes the VariFlight Cabin Layout API, including authentication, request parameters, response fields, JSON examples and error responses. The interface uses UTF-8 encoding.
Authentication
The interface uses both token and IP for concurrent verification.
Token generation algorithm (MD5)
Registration code: Please obtain the registration code from the administrator of VariFlight. It is necessary for verification during the request process by both parties. Please be careful not to disclose it to the public.
Example (PHP):
<?php
function generateToken(array $data, string $appsecurity): string {
unset($data['token']);
ksort($data, SORT_STRING);
$pairs = [];
foreach ($data as $key => $value) {
$pairs[] = $key . '=' . $value;
}
$str = implode('&', $pairs);
return hash('md5', hash('md5', $str . $appsecurity));
}
// 参数值使用 UTF-8 原文;通过 token 参数传入结果,构建 URL 时再编码。
// $data['token'] = generateToken($data, $appsecurity);
// $query = http_build_query($data, '', '&', PHP_QUERY_RFC3986);
Example (Java):
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.stream.Collectors;
import java.security.MessageDigest;
import java.util.HexFormat;
public class TokenExample {
public static String generateToken(
Map<String, String> data, String appsecurity) throws Exception {
String str = data.entrySet().stream()
.filter(entry -> !"token".equals(entry.getKey()))
.sorted(Map.Entry.comparingByKey())
.map(entry -> entry.getKey() + "=" + entry.getValue())
.collect(Collectors.joining("&"));
return digestHex(digestHex(str + appsecurity));
}
private static String digestHex(String value) throws Exception {
byte[] bytes = MessageDigest.getInstance("MD5")
.digest(value.getBytes(StandardCharsets.UTF_8));
return HexFormat.of().formatHex(bytes);
}
}
// 请求 URL 追加 "&token=" + URLEncoder.encode(token, StandardCharsets.UTF_8)。
Example (C#):
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Security.Cryptography;
public static class TokenExample {
public static string GenerateToken(
Dictionary<string, string> data, string appsecurity) {
string str = string.Join("&", data
.Where(entry => entry.Key != "token")
.OrderBy(entry => entry.Key, StringComparer.Ordinal)
.Select(entry => entry.Key + "=" + entry.Value));
return DigestHex(DigestHex(str + appsecurity));
}
private static string DigestHex(string value) {
using (var digest = MD5.Create()) {
byte[] result = digest.ComputeHash(Encoding.UTF8.GetBytes(value));
return BitConverter.ToString(result).Replace("-", "").ToLowerInvariant();
}
}
}
// 请求 URL 追加 "&token=" + Uri.EscapeDataString(token)。Query by Route + Date + Flight Number:
Request URL:
https://open-al.variflight.com/api/airplaneseat?appid=${appid}&arr=PEK&date=2023-12-14&dep=CAN&fnum=CA1310&lang=&token=${token}The parameter part in the URL is:
appid=${appid}&arr=PEK&date=2023-12-14&dep=CAN&fnum=CA1310&lang=&token=${token}
Generating the encrypted string:
str = appid=${appid}&arr=PEK&date=2023-12-14&dep=CAN&fnum=CA1310&lang=
Step2. The registration code is '${appsecurity}'. Assign this value to the variable $appsecurity.
Append appsecurity (the registration code) directly to str, with no extra separator.
Apply MD5 twice. Each result is a 32-character lowercase hexadecimal string. The second digest takes the UTF-8 bytes of the first Hex string, not its raw digest bytes.
token = md5Hex(md5Hex(str + appsecurity))
Note: $appsecurity=Registration code
API Endpoints
The request URL:
https://open-al.variflight.com/api/airplaneseat?The way to request: GET
The format of return: json
Request parameter Details
Cabin Layout employs an authorized authentication interface. At the beginning of the cooperation, VariFlight will apply on behalf of the third party to allocate user identification codes and registration codes (i.e., appid and appsecurity).
1 Response 1
Inquiry Method: 1: Query by Route + Date + Flight Number
| Request parameter | Description | Example | Required or Optional | Parameter Type |
|---|---|---|---|---|
appid |
Required | Yes | string |
|
lang |
No | string |
||
fnum |
Required | CA1310 | Yes | string |
dep |
Required | CAN | Yes | string |
arr |
Required | PEK | Yes | string |
date |
Required | 2023-12-14 | Yes | string |
token |
Required | Yes | string |
Inquiry Method: 2: Query by Aircraft Number
| Request parameter | Description | Example | Required or Optional | Parameter Type |
|---|---|---|---|---|
lang |
No | string |
||
appid |
Required | Yes | string |
|
aircraftnumber |
Required, without the "-" symbol | B2038 | Yes | string |
token |
Required | Yes | string |
Return Parameter Details
| Request parameter | Description | Example | Parameter Type |
|---|---|---|---|
FlightNo |
Flight Number | CA1835 | string |
FlightDate |
Flight Date | 2016-12-20 | string |
FlightDepCode |
Departure Airport IATA Code | PEK | string |
FlightArrCode |
Destination Airport IATA Code | PVG | string |
aircraftnumber |
when querying with the four parameters, aircraftnumber shows an empty value | B1234 | string |
cabin_pic |
Cabin Image URL | https://file.veryzhun.com/buckets/planeseat/keys/f86e9a829c0abc9f71730ba159a76aab.png | string |
Return Parameter Examples
Example 1: Failed return
{
"error_code": 3,
"error": "Lack of parameters or parameter identification failed"
}
Example 2: Successful return
{
"FlightNo" : "CA1835",
"FlightDate" : "2016-12-20",
"FlightDepCode" : "PEK",
"FlightArrCode" : "PVG",
"aircraftnumber" : "B1234",
"cabin_pic" : "https://file.veryzhun.com/buckets/planeseat/keys/f86e9a829c0abc9f71730ba159a76aab.png"
}Error Responses
| Return parameter | Description | Trigger Scene | Suggestions |
|---|---|---|---|
0 |
No data permissions | ||
2 |
The visiting ip have not been joined in white list | ||
3 |
This request method has no permission temporarily | ||
3 |
Lack of parameters or parameter identification failed | ||
10 |
No data | ||
8 |
No permissions to inquire future data | ||
7 |
No permissions to inquire data of current day | ||
6 |
No permissions to inquire historical data | ||
5 |
No permissions to inquire international data | ||
4 |
The current interface is expired | ||
4 |
The current interface is closed | ||
4 |
No data permissions | ||
1 |
Pending review | ||
11 |
Unknown error | ||
0 |
Invalid user |
