@flintpay/cli
弗林特公共API的官方命令行界面.
每个命令地图到文件 /v1 路由,所以通过HTTP你可以做的任何事,从外壳,脚本,或者CI工作.
安装
npm install -g @flintpay/cli
在 macOS 和 Linux 上运行 flint upgrade (或其别名) flint update),将全球软件包及其平台二进制更新到最新的稳定发行. 在Windows上,命令会打印关闭CLI后要运行的确切npm更新. flint upgrade --check 仅报告当前和最新稳定版本以及是否有更新.
此软件包解决您平台的预建二进制 。 节点 >=18 需要运行安装器。 在macOS和Linux上,你可以和Homebrew一起安装:
brew install flint-pay/tap/flint
签名( 建议)
为了当地的发展,请通过Flint网站登录:
flint auth login
flint doctor
确认您终端显示的代码, 并批准网站的 CLI 访问 。 Flint 验证 OAuth 会话并将其访问权限和刷新令牌存储在您的 OS 密钥链中。 使用 --no-open 自己打开打印链接, --profile NAME 用于现有配置文件,或 --live 明确要求生产准入.
如果浏览器无法登录, 请使用 flint auth import 换句话说.
浏览器登录给予共同开发工作流程的基准权限. 一些指挥小组,包括订阅、付款、报告、风险和先进的商业业务,需要更多的准入。 在活动上下文中添加范围 flint reauth --scope SCOPE; 重复 --scope 当操作需要多个范围时。 浏览器可能只批准部分请求,CLI报告所批准的内容. 在发出请求前将检查已知的命令要求.
访问令牌在需要时自动刷新 . flint auth logout --confirm 取消 OAuth 会话后,才能取消本地证书。 如果服务器不确认撤销,则登录报告失败并保留证书进行重试. 已导入的 API- key 登录仍然只删除本地密钥 .
flint login 是一个快捷键 flint auth login。相关的快捷键 : flint logout 页:1 flint auth logout,以及 flint whoami 页:1 flint auth status。 。 。 .
whoami, (中文(简体) ), auth status, (中文(简体) ), doctor,以及 config get 显示 API 基础 URL、 证书来源以及人类输出和下方所选配置文件 data.cli 在JSON。 (英语) 医生的检查结果低于 data.checks。 。 。 . config get 在不请求 API 的情况下解决本地配置; 无法读取的证书存储显示为 credential_source: "unavailable"。认证文本接受 mode (与 environment 作为后退, access,以及 auth_type: "cli_login"。Live-mode 守护人员使用经过验证的认证文本模式。 设定 FLINT_COLOR=auto|always|never 选择颜色,或以 --color。 。 。 .
会议和背景
批准在浏览器中访问选定的商家、沙盒和活环境,然后选择命令运行的地方:
flint login
flint context list
flint context switch # interactive selector
flint context switch ctx_development # select an authorized sandbox
flint context switch ctx_production --live # explicitly select a live default
flint auth status --context ctx_development # one command, without changing the default
flint reauth # change browser-approved access
flint login 重用已有效保存的 OAuth 会话,并在服务器确认会话已过期或被撤销时再次启动浏览器批准. 临时连接失败或失去对一个上下文的访问,不会自动取代会话. 使用 flint login --new-session 在浏览器批准后替换它; CLI 然后试图取消上一会话. flint logout --confirm 取消整个会话.
管理和取消会议 CLI会话页。 。 。 .
上下文选择用途 --context ID,然后一个项目的 .flint/config.json context_id 字段,然后是配置默认值。 譬如说, {"context_id":"ctx_development"} 标出一个工程。 切换会改变配置默认值,而不是工程标点. 每个运行中的命令保留其起始上下文. 访问令牌仍限于一个上下文并自动刷新. LIVE 上下文在选择器和命令诊断中标出标签;选定的多文本会话不需要 --live ,而敏感/破坏性行动仍需要确认.
环境证书FLINT_API_KEY 或者说 FLINT_ACCESS_TOKEN覆盖已配置的浏览器会话上下文 。 明确 --context 无法与这些覆盖合并 。 商船和沙盒的守卫依然适用.
若为 flint context list 报告无法提供环境,您现有的登录仍然可用,并保持其运行模式保障。 运行 flint reauth 后来授权多个上下文.
API 密钥和自动化
对于手动设置,请在 弗林特仪表板 运行 flint auth import. 对于CI, 供应 FLINT_API_KEY 通过你的秘密商店 和设置 FLINT_NO_INPUT=1。 。 。 . flint signup 用于从终端创建一个账户.
收钱
flint checkout create \
--quick-pay-name T-shirt \
--amount 2500 \
--currency USD \
--open
数量是货币最小单位的整数,所以 2500 25块.
转发到本地主机
flint listen --forward-to http://localhost:8080/webhooks/flint
这个将您的沙盒事件流到本地服务器, 并有真实的签名, 所以开发时不需要隧道 .
脚本
对于有界限的命令, --output json 在 Stdout 上打印一个 JSON 信封并禁用终端输入提示. flint auth login 仍然需要网站批准; FLINT_NO_INPUT=1 压制在允许网站审批和投票的同时自动打开浏览器. 使用 FLINT_API_KEY 用于无人处理的自动化。 流出命令则释放出新线- 限定的 JSON . flint listen --output json 每行写一个收听器、webhook事件、交付结果或检查对象; 使用 --max-events 或者说 --for 绑住它。 诊断和进展都转到了 stderr, 所以 stdout 保持一个干净的数据流.
退出代码稳定 : 0 成功吗, 1 API 错误, 2 使用错误, 3 认证或配置, 4 需要确认, 5 网络, 6 --wait-for 超时, 70 内部出错,包括缺少或不支持的平台二进制.
在CI中,通过键 FLINT_API_KEY 而不是键链,并设定 FLINT_OUTPUT=json 财务报告和审定财务报表 FLINT_NO_INPUT=1 使每个命令不互动.
文档
- 指南 : https://developers.withflintpay.com/docs/guides/cli 页面存档备份,存于互联网档案馆
- API 参考 : https://developers.withflintpay.com/docs/api 页面存档备份,存于互联网档案馆
flint help关于起点,flint <command> --help用于任何单一命令flint schema commands customers --output json用于一组的机器可读命令; 省略组的完整、大目录flint schema input customers create --output json一个命令的JSON Schema--input机构
许可证
阿帕奇 - 2.0