Compulife API - 文档(README.HTML)




目录

  1. 介绍
  2. 概述
  3. 邮差集合 - 参考文档
  4. 样本请求
  5. 需要授权ID的示例请求
  6. 示例日志文件和调试技巧



1.介绍

Compulife API旨在通过使用JSON格式数据来访问Compulife Internet引用引擎软件。 API具有公共(任何人可以使用)或私人(必须具有Computife授权ID)的部分。 只允许一台服务器访问每个授权ID的Compulife API,并且通过将ID与IP地址匹配来跟踪此操作。 首次使用CompulifeAuthorizationID用于该请求的IP,并被假定为您将使用的IP。 将代码移动到新服务器将要求您与我们联系以重置您的信息。这适用于开发/直播服务器,如果您的开发服务器和直播服务器具有不同的IP地址。


2.概述

API可以直接使用,或者您可以使用本地PHP / JavaScript库,这对您进行了大量提升界面。

API功能包括:


3.邮递员集合 - 参考文档

我们为您的参考和开发使用创建了邮递员集合:

//docs.compulife.com


4.示例请求

类似于我们的邮差集合, API-Sample-Requests.php 参考可以从本地计算机或服务器使用的示例。它不需要任何PHP代码以运行,但返回的结果以JSON格式为单位,因此仅用作附图标识。大多数浏览器可以添加插件或扩展 将JSON格式化为更可读的内容,但这显然不适合其他其他方面的开发参考目的。

一些示例请求不需要授权ID。如果需要授权ID,则需要配置Config.php页面。

在通过示例之后,页面的底部显示生成的URL以便从API获取结果。

重要提示:您的Compulife授权ID仅对一个IP地址有效,因此如果您在不同的服务器上正在开发开发,则必须调用Computife以重置Compulife授权ID。


5.需要授权ID的示例请求

额现 - sample.php. 显示示例报价表格,并显示工作结果。 它使用本地Compulife API PHP和JavaScript代码来调用引擎并将处理呼叫的日志。 要使用此CONFIG.PHP必须更新

  1. 授权ID.
  2. 您希望记录日志文件的服务器路径

您还需要创建将放置日志文件的目录。

具有报价器-Mample.php有三个查找示例。

  1. 引用结果 - 在同一页面上显示Ajax样式的结果。
  2. 并排电子表格 - 再次显示同一页面上的Ajax样式的结果。
  3. 健康分析仪 - 继续向健康分析仪调查问卷页面提出关于客户的健康的更详细问题。此页面相当复杂,因此我们建议将您的编辑限制为Light CSS类型的编辑。 单击此页面上的提交转到结果,该PHP是实际的API查找,并将在同一页面上显示Ajax样式的结果。

重要提示:您的Compulife授权ID仅对一个IP地址有效, 因此,如果您在不同的服务器上正在开发,您将不​​得不打电话给我们来重置Compulife授权ID。


6.示例日志文件和调试提示

日志文件名被格式化为日志yog-mm-dd.log
详细信息可以在CONFIG.php中设置,默认为“4”,它显示全部。

示例日志条目是:
INFO - 2020-07-11 00:08:50-->===== Request Start =====
INFO - 2020-07-11 00:08:50-->json={" 抚养 AUTHORIZATIONID":"INSERT_ID","BirthDay":"20","BirthMonth":"9","BirthYear":"1987","CompRating":"4","ErrOnMissingZipCode":"ON","FaceAmount":"250000","Health":"PP","ModeUsed":"M","NewCategory":"7","Sex":"M","Smoker":"N","SortOverride1":"A","State":"0","ZipCode":"84081"}
INFO - 2020-07-11 00:08:50-->api request string = //www.compulifeapi.com/api/request/?COMPULIFE={" 抚养 AUTHORIZATIONID":"INSERT_ID","BirthDay":"20","BirthMonth":"9","BirthYear":"1987","CompRating":"4","ErrOnMissingZipCode":"ON","FaceAmount":"250000","Health":"PP","ModeUsed":"M","NewCategory":"7","Sex":"M","Smoker":"N","SortOverride1":"A","State":"0","ZipCode":"84081"}

API请求字符串可以放入浏览器的地址栏中,并将在JSON中显示结果。 这对于调试出现问题的地方非常有用。请记住,您的IP地址的CompulifeAuthorizationID必须匹配,如果您的浏览器处于不同的IP地址,则您正在调试的服务器会影响您的结果。在这种情况下,在您的服务器上制作一个微小的HTML页面,该页面将请求字符串作为链接,以获取结果。