README

完整文档在

https://www.ispfy.com.br/api/postman

访问端口

• 端口 8020 用于 HTTP 和 8043 用于 HTTPS（优先使用 HTTPS，因为内容可能会被截获，包括 TOKEN）
• 在系统 > 网络 > 防火墙中放开

认证令牌

应在 Header 中带有 'token' 标签发送

结构

• OBJECT 路由根据其路由的过滤器（查询）返回对象列表
• TOOL 路由有自己的查询
• OBJECT 和 TOOL 路由不共享相同的过滤器
• 令牌对每个用户都是唯一的，并继承其权限

可用端点

• GET => /object/geofiber/cto

• GET => /object/geofiber/spliter

• GET => /object/geofiber/spliter/via

• GET => /object/carteira

• GET => /object/cidade

• GET => /object/cliente

• GET => /object/cliente/contrato

• GET => /object/cliente/contrato/ponto

• GET => /object/cliente/contato

• GET => /object/suporte/ticket

• GET => /object/suporte/topico

• GET => /object/cliente/contrato/cobranca

• GET => /tool/cobranca/imprimir/{id}

• GET => /tool/assinante/boleto

• GET => /tool/assinante/info

• POST => /tool/assinante/login

• POST => /tool/assinante/liberar

• POST => /tool/assinante/ticket

TOOL 类型路由的查询

• GET /tool/cobranca/imprimir/{boleto 编码} (通过编码打印一张票据)

• GET /tool/assinante/boleto (票据的第二联，自定义)

  • doc: CPF/CNPJ
  • status: [已过期, 即将过期, 所有]
  • type: [收据, 扩展, 发票, 行]

• GET /tool/assinante/info (返回客户的数据、合同、点、收费和调用)

  • id: 客户编码
  • doc: CPF/CNPJ

• POST /tool/assinante/login (尝试登录订阅者中心并返回一个客户对象，如果成功)

  • username: 订阅者中心的客户 CPF/CNPJ
  • password: 订阅者中心的客户密码（MD5加密）

• POST /tool/assinante/liberar (释放合同中的互联网点3天)

  • id_contrato: 要释放的合同编码

• POST /tool/assinante/ticket (打开一个票据)

  • id_cliente: 系统中的客户编码（必需）
  • id_ponto: 系统中的互联网点编码（可选）
  • id_topico: 调用的打开主题（必需）
  • setor: 调用将发送到的部门的标签（必需：TECNICO, COMERCIAL 或 FINANCEIRO）
  • requisicao: 订阅者的请求文本（必需）

OBJECT 类型路由的查询

• limit: 要显示的记录限制

  • -1 = 无限制
  • default: 10

• offset: 从该记录开始计数直到限制的记录编号

  • default: 0

• sort: 从小到大或从大到小排序

  • nome_do_acmpo:ASC 从小到大（默认）
  • nome_do_acmpo:DESC 从大到小

• paginaton: 如果为 TRUE，则在 body 中返回内容，offset，limit 和行数。

  • default: False
  • 示例

	[
	    "data" => [{nome: joao}],
	    "count" => 40,
	    "offset" => 5,
	    "limit" => 10
	]

• filter: 通过字段、操作符和比较器过滤内容
  • 例如：data_vencimento:GT:2019-01-01 [AND] data_vencimento:LT:2019-12-31
  • nome_do_campo:operador:valor
  • 操作符: [OR], [XOR], [AND] (用括号括起来)
  • 比较符
    • EQ: 等于
    • NOT: 不同
    • LT: 小于
    • LTE: 小于等于
    • GT: 大于
    • GTE: 大于等于
    • START: 以...开始
    • END: 以...结束
    • CONTAINS: 包含
    • IN: 存在于列表 [x,y,z]（项目用逗号分隔）
    • NOTIN: 不在列表 [x,y,z] 中（由逗号分隔的项目）
    • BTW: 在值 A 和值 B 之间（由逗号分隔的两个项目）