开发者资源



添加Queue-Fair

Queue-Fair虚拟候机室可在几分钟内轻松添加到各种网络和应用程序平台。 只需使用我们的一个适配器。 你可以在技术指南Queue-Fair门户>帮助部分找到更多关于将Queue-Fair与你现有系统整合的最佳方式。

客户端适配器

对于网站来说,与 Queue-Fair 集成的最简单方法是将客户端 Queue-Fair 适配器 JavaScript 标签添加到您的页面。 你可以安全地将适配器添加到网站上的所有页面,并使用Queue-Fair门户中的激活规则来确定哪些页面可以抛出一个队列。

因为它在你的访问者的浏览器中运行,客户端适配器可以被技术熟练的访问者禁用,但在防止过载方面非常有效,因为只有极少数人会试图通过篡改JavaScript来跳过队列。 我们的大多数客户都使用客户端适配器,因为它能有效地防止网站崩溃,安装简单,而且不会在我们的系统和你的系统之间引入任何依赖关系。

你可以通过用服务器端适配器替换JavaScript标签来增加一个安全层,或者将JavaScript适配器的灵活性与本页面描述的混合安全模型结合起来;然后这两种方法都是安全的。

单行代码

要将客户端适配器添加到你的网站,只需将以下一行代码添加到 <head> 你的页面的部分:

用这一行代码将我们的虚拟候车室添加到你的网站上,防止网站崩溃

一些客户添加了单词 defer 标签,这将导致Adapter脚本在解析页面的同时被下载,并且只有在页面解析完成后才开始在访问者的浏览器中执行该脚本(所以通常在你的页面上的任何其他脚本完成后)。

在某些情况下,添加defer这个词可以将 "首次绘画时间 "提高一小部分,但如果你选择这样做,就意味着任何应该被排队的访问者在被送入队列之前会多看到你的保护页面一小部分时间。

谷歌标签管理器

我们还通过谷歌标签管理器提供JavaScript适配器标签。 在社区模板库中搜索Queue-Fair,在添加标签下搜索。 请注意,一些广告拦截器阻止从谷歌下载主gtm.js,这将阻止谷歌标签管理器的所有操作,包括为这些访问者运行适配器。我们用于谷歌标签管理器的虚拟候机室标签

GitHub 储存库

谷歌标签管理器

谷歌标签管理器

Queue-Fair虚拟候机室谷歌标签管理器客户端适配器标签的GitHub存储库.

动态队列页面

通过使用客户端JavaScript标签和谷歌标签管理器中的data-queue-fair-extra属性,你可以将任何数据从你的网站传递到我们的服务器和你的访问者看到的队列页面。如果你希望在你的账户上启用动态队列页面,请联系支持部门

您可以使用这一功能,即时定制队列页面。 您还可以使用Queue-Fair将您发送给我们的数据与您的访客一起传回您的网站,因为他们是通过队列的,以获得额外的安全层。

我们还提供动态队列页API,使用额外的数据来定制队列页的任何方面,因此您可以为整个网站创建一个队列,并针对网站上的不同事件或产品自动定制,而无需对Queue-Fair门户中的队列页进行任何修改



Wordpress & WooCommerce

如果你使用的是基于Wordpress的网站,如WooCommerce购物车系统,你可以使用Wordpress Insert Headers & Footers Plugin轻松地添加客户端JavasScript适配器标签,而无需修改你的任何Themes或触摸任何Wordpress代码。

只要下载Insert Headers & Footers插件,将其解压到你的/wp-content/plugins/文件夹中,在插件菜单中激活该插件,从设置菜单中打开该插件,将标签添加到Header中的Scripts中,如图所示,在页面底部点击Save,就可以了!

Queue-Fair门户仪表板

客户端适配器的其他资源

客户端适配器在《技术指南》中有充分的描述。 该技术指南可在Queue-Fair门户>帮助部分获得,或者你可以向我们索取一份副本


服务器端适配器

客户端适配器在访问者的浏览器中以JavaScript运行,而Queue-Fair服务器端适配器则在你的网络服务器上运行。

网络服务器适配器

这意味着你的网络服务器可以利用额外的安全功能,拒绝没有被排队的人访问。 这也意味着你的网络服务器避免了生成和提供包含适配器脚本的页面的负担。

添加Queue-Fair服务器端适配器库只需几分钟时间,只需对代码进行最小的修改即可激活和运行该适配器。

我们的大多数客户从客户端JavaScript适配器开始,只有在有特定业务需求的情况下才会转向服务器端适配器。

简单和安全模式

Queue-Fair服务器端适配器可以在简单或安全模式下运行。

简单模式所有访问者被发送到Queue-Fair服务器进行统计,无论是否形成队列。 当没有队列时,他们会直接返回到您的网络服务器,而不会看到队列页面 - 但您的网络服务器需要签名,以确保只有被队列通过的人才能访问您的受保护资源。

安全模式下,只有在有队列的情况下,访问者才会被发送到Queue-Fair服务器。 您的网络服务器直接咨询我们的队列服务器,以作出这一决定。 无论是否显示队列页面,访问者仍然被安全地数字签名。

安全模式建议用于日常的队列。 简单模式适合于你预期有数千人的定时活动,因为它消除了从你的网络服务器到我们的队列服务器的检查调用所造成的延迟,这意味着你可以更有效地把人送到队列中。

GitHub 储存库

PHP虚拟候机室适配器') ?>

PHP

Queue-Fair服务器端适配器的GitHub仓库,在PHP中。

Java虚拟候机室适配器

Java

用于Java(包括JBoss和Tomcat)的Queue-Fair虚拟候机室服务器端适配器的GitHub存储库。

红宝石虚拟候机室适配器

Ruby

在Ruby和(可选择)Rails中的Queue-Fair虚拟候机室服务器端适配器的GitHub存储库.

Python虚拟候机室适配器

Python

Queue-Fair虚拟候机室服务器端适配器的GitHub仓库,采用Python和(可选)Django编写。

dotNet虚拟候机室适配器

.NET

用于.NET、ASP和C#的Queue-Fair虚拟候机室服务器端适配器的GitHub仓库。

Node.js & JavaScript虚拟候机室适配器

Node.js & JavaScript

用于Node.js和(可选)Express的Queue-Fair虚拟候机室服务器端适配器的GitHub存储库。



动态队列页面

与客户端适配器一样,你希望的任何数据都可以从你的网络服务器传递到我们的服务器,以及你的访问者通过在服务器端适配器调用中传递这些信息看到的队列页面。 这有利于动态队列页或其他即时定制的方式--客户端适配器的所有功能都得到完全支持。如果你想在你的账户上启用动态队列页,请联系支持

服务器端适配器的其他资源

我们的服务器端适配器在《技术指南》中有充分的描述。 该技术指南可在Queue-Fair门户>帮助部分获得,或者你可以向我们索取一份副本。 你也可以在每个GitHub资源库的README.md中找到关于每个适配器的更多信息。


REST APIs

Queue-Fair让开发者访问六个REST API模块。 您需要一个Queue-Fair账户来使用该API。 要为您的账户启用 API 访问,请联系 Queue-Fair 支持。 我们的REST API模块符合OpenAPI、RFC 7807和RFC 3339标准。

我们的API模块套件是全面的--你可以在门户中做的任何事情,你也可以用API来做,但管理门户用户除外,因为隐私原因,这不包括在内。

每个API模块都在api.queue-fair.net上有完整的文档,在那里你还会发现一个Swagger接口,以便于使用和测试。 为了安全起见,所有的API调用都受到安全的TLS加密保护,并需要一个特定于你账户的API密钥。

API模块

报告API

用于实时报告、历史报告和队列汇总统计。

队列管理API

用于实时以编程方式创建和修改队列。

账户管理API

用于查看和更新你的账户范围内的设置。

资产管理API

用于管理由谷歌CDN提供服务的队列页面所使用的资产。

演示API

用于改变你的队列页面的HTML的任何方面,以及即时更新和创建变体。

激活API

用于配置激活规则,确定你的网站上的哪些页面可以触发队列,以及显示哪些页面。



动态队列页面

你也可以使用门户或演示API,在无需更新数据库的情况下,即时修改你的队列页 -联系支持部门以了解更多细节,并在你的账户上启用动态队列页。

REST API的其他资源

根据RFC 7807的要求,你可以在queue-fair.com/api-error找到关于我们的REST API模块可能返回的错误信息的文档。


本地应用程序

Queue-Fair在移动浏览器以及台式机和笔记本电脑上看起来很好。

你也可以在你的原生iOS和Android应用程序中直接使用Queue-Fair,也可以在iOS、Android、Windows和MacOS上使用React Native应用程序,以保护资源密集型活动或操作。

Queue-Fair应用适配器使用WebClient在你的服务过于繁忙时向你的用户显示自定义队列显示,具有灵活性和易用性。 Queue-Fair Portal.

你可以将用户排在与你的网站访客相同的队列中,或者为你的应用程序用户设置一个单独的队列--这取决于你。

就像我们基于网络的队列一样,如果每个用户从你的应用程序中导航离开,他们的位置也会自动保存。

GitHub 储存库

iOS、MacOS和苹果虚拟候机室适配器

iOS & MacOS

Queue-Fair虚拟候机室iOS和MacOS适配器的GitHub仓库。

安卓虚拟候机室适配器

Android

Queue-Fair安卓版虚拟候机室适配器的GitHub仓库。

React Native App虚拟候机室适配器

React Native

用于Android、iOS、MacOS和Windows的React Native应用程序的Queue-Fair虚拟候机室适配器的GitHub仓库。

队列通知

Queue-Fair适配器可以轻松地将推送通知发送给没有使用你的应用程序或队列的用户,当他们被呼叫时。 用户在队列中的位置会自动由适配器持久地存储在你的应用程序中。 如果用户离开了你的应用程序,你的应用程序会告诉你的推送通知服务器应该发送通知,将存储的队列位置信息作为该消息的一部分发送给你的推送通知服务器。

这是我们用于WeQ4U消费者应用程序的相同技术,仅在英国就有约200万次下载。

你的推送通知服务器会定期查阅Queue-Fair状态API,以查询当前正在服务的队列位置。 当它大于某个特定用户的队列位置时,就是向该用户发送通知的时候了。 如果用户在发送推送通知之前返回队列或被通过,适配器会通知你的应用程序,而你的应用程序会告诉你的推送通知服务器不再需要通知。

据我们所知,我们是唯一支持这一功能的虚拟候机室供应商。

视频资源

这里有一段Native App Adapter的操作视频,显示即使App完全停止,用户的位置也会被保存,还显示了你的App用来发送Push Notifications的Adapter挂钩。

其他资源

我们的本地应用程序适配器在《技术指南》中有所描述。 该技术指南可在Queue-Fair门户>帮助部分获得,或者你可以向我们索取一份副本。 你也可以在每个GitHub仓库的README.md中找到更多关于iOS和Android特定的适配器的信息。


电子商务适配器

使用上述的客户端JavaScript适配器,Queue-Fair可以很容易地添加到任何电子商务系统中。

我们还提供适配器代码,以便在服务器端与许多流行的电子商务服务器一起工作。

GitHub 储存库

Magento Plugin

Magento

用于Magento的Queue-Fair虚拟候机室适配器的GitHub存储库。

WooCommerce/PHP虚拟候机室适配器

WooCommerce

Queue-Fair虚拟候机室适配器的GitHub仓库,用于WooCommerce的PHP版本。

PrestaShop/PHP虚拟候机室适配器

PrestaShop

Queue-Fair虚拟候机室适配器的GitHub仓库,适用于PHP中的PrestaShop。

其他资源

我们的适配器在《技术指南》中有所描述。 技术指南可在Queue-Fair门户>帮助部分找到,或者你可以向我们索取一份

我们也有适用于大多数电子商务平台的补充指南--只需询问您想要的那一个。


混合安全

你可以轻松地将客户端JavaScript适配器的灵活性与我们服务器端代码提供的额外安全层结合起来。

Queue-Fair用一个数字指纹对我们通过的每个访客进行签名,该指纹对该访客是独一无二的。 在业内独一无二的是,该签名还包括访客浏览器的特定代码,以防止访问令牌被共享。

您的网络服务器可以使用只有您和我们知道的秘密来验证签名,而不是您的访客,以确保每个访客都公平地通过了Queue-Fair服务器。

因此,你可以使用客户端的JavaScript适配器来发送和接收进出队列的访问者,并在他们下单前用最少的服务器端代码检查是否有篡改行为,并避免引入对我们系统的依赖性。

在我们的GitHub存储库中包含了每一种主要网络编程语言的示例代码。

GitHub 储存库

PHP

PHP

Queue-Fair服务器端适配器的GitHub仓库,在PHP中。

Java

Java

用于Java(包括JBoss和Tomcat)的Queue-Fair虚拟候机室服务器端适配器的GitHub存储库。

Ruby

Ruby

Queue-Fair虚拟候机室服务器端适配器在Ruby和(可选)Rails中的GitHub存储库。

Python

Python

Queue-Fair虚拟候机室服务器端适配器的GitHub仓库,采用Python和(可选)Django编写。

.NET

.NET

用于.NET、ASP和C#的Queue-Fair虚拟候机室服务器端适配器的GitHub仓库。

Node.js & JavaScript Virtual Waiting Room Adapter') ?>

Node.js & JavaScript

用于Node.js和(可选)Express的Queue-Fair虚拟候机室服务器端适配器的GitHub存储库。

其他资源

混合安全模式在《技术指南》中有充分的描述。 技术指南可在Queue-Fair门户>帮助部分获得,或者你可以向我们索取一份


许可证

我们在GitHub Queue-Fair仓库发布的代码是根据MIT许可的,这是最宽松的开放源代码许可之一。


想知道Queue-Fair如何运作吗?