最终幻想14 国服Garland Tools数据库api文档
apiBase = "https://garlandtools.cn/api/"
后文均略为 ./
。
不知为何在代码块中打不出$符号,因此使用&打头表示这是你之前传入的参数的值。
有问题直接群里问,这边根本看不到。
上一篇英文的api文档相对更新得多一点,机制完全一样,换链接根目录就行,暂时没有时间更新到这边,有需求的话麻烦先看英文的那篇。
企鹅群 217748914 有问题直接问不用考虑太多
Contents
对于桌面版网页,页面左侧也有目录,请善用。
获取游戏指定条目信息
单个
GET ./get.php
GET ./get.php?id=1&type=item&lang=chs&version=3
GET ./get.php?id=190&type=fishing&lang=chs&version=2
参数
参数 | 含义 | 值 |
---|---|---|
id | 你要查询的条目id,如物品id, 鱼池id,部分类别有特殊使用。 | \ |
type | 查询结果的类别,在下面会有每种结果的详细说明 | achievement, action, browse, fate, fishing, item, leve, map, mob, node, npc, quest, status, venture |
lang | 语言 | 仅限chs |
version | 内部版本号,固定值 | leve, item 为3,其他均为2 |
返回
下文将会介绍返回的 JsonObject。
{
"&type": result_JsonObject
}
一次查询多个
GET ./get.php?id=1,2,3,4,5&type=item&lang=chs&version=3
参数
参数 | 含义 | 值 |
---|---|---|
id | 使用英文逗号 , 来分割多个id | \ |
返回
下文将会介绍返回的 JsonObject。
[
{
"id": "&id[0]",
"obj": {
"&type": result_JsonObject
}
},
{
"id": "&id[1]",
"obj": {
"&type": result_JsonObject
}
},
……
]
搜索
注意,考虑到服务器性能与维护成本,本站并未安装elastic search,(在装了在装了咕咕咕咕咕咕咕)因此文本搜索仅支持词首匹配,例如传入黑铁,结果中将包含以黑铁开头的物品。但传入铁锭,并不能搜索到黑铁锭等物品。建议使用xivapi或cafemaker来完成搜索,取得物品id后直接获取数据。
单次搜索最多返回100条数据
./search.php
./search.php?text=黑铁锭&type=item&exact=1
./search.php?text=以太&type=item&rarity=7&ilvlMin=55&ilvlMax=110
参数
参数 | 含义 | 值 | 可不传入 |
---|---|---|---|
text | 搜索文本 | string | 否 |
type | 限定结果类型 | 见第一节 | 是 |
exact | 精确匹配 | 携带该参数即视为true | 是 |
$filter | 搜索物品时的物品筛选条件 | 见下表 | 是 |
Filter | 含义 | 值 | 可不传入 |
---|---|---|---|
ilvlMin | 最低物品等级 | int | 是 |
ilvlMax | 最高物品等级 | int | 是 |
elvlMin | 装备的最小要求等级 | int | 是 |
elvMax | 装备的最大要求等级 | int | 是 |
pvp | 搜索pvp技能用 | 携带该参数即视为true | 是 |
craftable | 可制作 | 携带该参数即视为true | 是 |
desynthable | 可分解 | 携带该参数即视为true | 是 |
collectable | 可放入收藏柜? | 携带该参数即视为true | 是 |
rarity | 物品稀有度 有些配方 0, 白色 1,绿色 2,蓝色 3,紫色 4,粉色 7 | int | 是 |
itemCategory | 物品类别 | str, 探索中 | 是 |
itemCategories | 多个物品类别 | str[], 用逗号分隔即可 | 是 |
jobCategories | 可穿戴的职业 | str[], 中文标准职业名,逗号分隔 | 是 |
clvlMin | 最低制作等级 | int | 是 |
clvlMax | 最高制作等级 | int | 是 |
craftJob | 制作职业 | str, 中文标准职业名,仅单个 | 是 |
ids | 条目的id | str[],逗号分隔 | 是 |
返回
下文将会介绍返回的 Partial。
[
{
"type": result_type,
"id": result_id,
"obj": result_Partial
},
{
"type": result2_type,
"id": result2_id,
"obj": result2_Partial
},
……
]
天气
GET ./weather.php
查询接下来各地的天气。
没有参数。
返回
{
"利姆萨·罗敏萨": ["碧空", "碧空", "晴朗", "阴云", "晴朗", "晴朗", "碧空", "晴朗", "小雨", "碧空"],
"利姆萨·罗敏萨上层甲板": ["碧空", "碧空", "晴朗", "阴云", "晴朗", "晴朗", "碧空", "晴朗", "小雨", "碧空"],
"利姆萨·罗敏萨下层甲板": ["碧空", "碧空", "晴朗", "阴云", "晴朗", "晴朗", "碧空", "晴朗", "小雨", "碧空"],
"中拉诺西亚": ["碧空", "碧空", "晴朗", "阴云", "晴朗", "微风", "碧空", "晴朗", "小雨", "碧空"],
……
}
返回对照一览表
Action 技能
翻译为技能仅仅是一种妥协。注意使用食物、吃恢复药等等使用物品的行为、以及各种失传技能、文理技能、任务指令等都算为技能。
JsonObject
待填坑
Partial
字符 | JsonObject对应 | 含义 |
---|---|---|
i | id | 技能id |
n | name | 名称 |
c | icon | 图标 |
j | job | 使用职业 |
t | category | 类别,如战技,能力,魔法 |
l | lvl | 等级要求 |
Achievement 成就
JsonObject
待填坑
Partial
字符 | JsonObject对应 | 含义 |
---|---|---|
i | id | id |
n | name | 名称 |
c | icon | 图标,调用此图标请 "https://ffxiv.cyanclay.xyz/files/icon/achievement/{}.png".format(icon) ,我相信你一定能看懂我在说啥 |
t | category | 类别 |
b | 分情况 | 若成就有奖励,则此项为成就奖励的物品名。若没有则是成就描述的前50个字。 |
Leve 理符
JsonObject
待填坑
Partial
字符 | JsonObject对应 | 含义 |
---|---|---|
i | id | id |
n | name | 名称 |
l | lvl | 理符任务等级 |
j | jobCategory | 职业类型:战斗精英,魔法导师,大地使者,能工巧匠 |
p | areaId | 接取地图的id |
Fate 危命
JsonObject
待填坑
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
l | lvl | 危命任务等级 | 是 |
t | type | 危命的类型,注意此项可能在未来翻译时有所变动。目前有以下的几种返回:Slay Enemies (杀小怪), Notorious Monster (打boss), Gather (捡垃圾), Defense (保卫萝卜), Escout (护送), Path (没见过不知道这是啥), EurekaNM (优雷卡NM), Unknown. 目前博兹雅的相关fate、天穹同庆相关fate暂时会返回Unknown,之后会变动,请注意。 | 是 |
z | zoneId | 接取地图?地区?的id,注意不一定含有此值 | 否 |
c | coords | 坐标,注意不一定含有此值 | 否 |
Quest 任务
JsonObject
摸鱼
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
l | lvl | 任务等级 | 是 |
g | genre | 任务的类型的id,太多了这里就不列了。就是游戏中在旅行笔记那里回看动画时会显示的任务分类,具体列表可见 https://github.com/thewakingsands/ffxiv-datamining-cn/blob/master/JournalGenre.csv 是这张表里的第一列key值 | 是 |
l | location | 接取的地图?地区? 的中文名 | 是 |
s | sort | SortKey,我也不知道是啥,可能是任务排序的依据? | 是 |
r | repeatable | 可重复完成任务 | 否 |
f | unlockFunction | 能够解锁一些任务或者功能 | 否 |
NPC
JsonObject
快乐摸鱼
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
s | hasShop | 是否开商店,返回商店的数量 | 否 |
q | hasQuest | 是否有任务,返回任务的数量 | 否 |
k | hasTalk | 是否能对话,返回对话的数量 | 否 |
t | title | 一般是npc的职能,就是npc名字下面有书名号的那个,例如《杂货商人》《理符发行人》 | 否 |
r | trade | 是否接受交易(以物换物) | 否 |
a | areaid | 所在地图id | 否 |
c | coords | 坐标 | 否 |
Mob 怪物
怪物数据目前只有到4.x的
JsonObject
啦啦啦
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
l | lvl | 等级 | 是 |
z | zoneid | 所在地图id | 否 |
t | instance | 所在副本名 | 否 |
Item 物品
JsonObject
阿巴阿巴阿巴阿巴
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
l | ilvl | 物品等级 | 是 |
c | icon | 图标路径,调用图标请"https://ffxiv.cyanclay.xyz/files/icon/item/{}.png".format(icon) |
是 |
t | category | 物品类别 | 是 |
p | price | 商店贩售价格 | 否 |
materia | materia | 魔晶石? | 否 |
Fishing Spots 鱼池
JsonObject
阿巴阿巴阿巴阿巴
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
l | lvl | 等级 | 是 |
c | category | 鱼池类别,淡水垂钓、海洋垂钓、沙海垂钓、浮岛垂钓、云海垂钓、熔岩垂钓、魔泉垂钓、盐湖垂钓中的一个 | 是 |
z | zoneid | 地图id | 否 |
x | x | 坐标x | 否 |
y | y | 坐标y | 否 |
Node 采集点
JsonObject
哇哇哇怎么这么多啊啊啊啊啊啊
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
l | lvl | 等级 | 是 |
t | type | 采集点类型,注意该项会在未来翻译中变动,目前将返回 Mineral Deposit (矿脉),Rocky Outcropping (石场),Mature Tree (良材),Lush Vegetation (草场) | 是 |
z | zoneid | 地图id | 是 |
s | stars | 采集点星数(传承录) | 否 |
lt | limitType | 限制类型,注意该项可能会在未来翻译中变动,目前返回 Unspoiled (未知的),Legendary (传说的),Ephemeral (限时的) | 否 |
ti | time | 限时时间,是数组 | 否 |
Statuses 状态
JsonObject
终于没了呜呜呜
Partial
字符 | JsonObject对应 | 含义 | 一定含有此值 |
---|---|---|---|
i | id | id | 是 |
n | name | 名称 | 是 |
c | icon | 图标,调用图标请"https://ffxiv.cyanclay.xyz/files/icon/status/{}.png".format(icon) |
是 |
t | category | 类别,只有增益和减益两种 | 是 |