README

如何在您的 Laravel/Lumen 项目中安装此包

在您的项目目录下，在终端中执行以下命令

composer require fausto/fpay-module "dev-master"

安装包后，需要在 config/app.php 文件中添加 provider，只需打开文件并在 providers 数组中添加以下行 \Fgmarins\Fpay\FpayServiceProvider::class

注意：provider 需要添加以合并路由文件，使它们可用于请求。

完成此操作后，需要在您的 .env 文件中添加 CLIENT_CODE 和 CLIENT_KEY。

为了执行测试，可以在 .env 文件中添加以下行

CLIENT_CODE=FC-SB-15
CLIENT_KEY=6ea297bc5e294666f6738e1d48fa63d2

完成这些步骤后，包已准备好使用。

以下是要使用的端点

• /api/v1/fpay/sales (GET)
• /api/v1/fpay/namedocument (GET)
• /api/v1/fpay/installments (GET)

可以发送的参数与两个路由相同，如下所示

nu_referencia - (String | Max 20 caracteres)
nu_venda - (String | Max 20 caracteres)
page - (Integer)
per_page - (Integer)
dt_venda - (Date | YYYY-mm-dd)

注意：参数是可选的。

Postman 中的测试路由（集合）

要导入创建的测试路由，请打开 Postman 并在顶部菜单中点击 File > Import > Raw Text，然后添加以下文本

{
	"info": {
		"_postman_id": "7c6ae951-c5d2-4f23-a2ea-783b0a55ba16",
		"name": "FpayModule",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Sales",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/v1/fpay/sales?nu_referencia=REF0001&nu_venda=38425-uGet3-2KFMj&page=0&per_page=10&dt_venda=2020-04-14",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"v1",
						"fpay",
						"sales"
					],
					"query": [
						{
							"key": "nu_referencia",
							"value": "REF0001"
						},
						{
							"key": "nu_venda",
							"value": "38425-uGet3-2KFMj"
						},
						{
							"key": "page",
							"value": "0"
						},
						{
							"key": "per_page",
							"value": "10"
						},
						{
							"key": "dt_venda",
							"value": "2020-04-14"
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "NameAndDocument",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/v1/fpay/namedocument?nu_referencia=REF0001&nu_venda=38425-uGet3-2KFMj&page=0&per_page=10&dt_venda=2020-04-14",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"v1",
						"fpay",
						"namedocument"
					],
					"query": [
						{
							"key": "nu_referencia",
							"value": "REF0001"
						},
						{
							"key": "nu_venda",
							"value": "38425-uGet3-2KFMj"
						},
						{
							"key": "page",
							"value": "0"
						},
						{
							"key": "per_page",
							"value": "10"
						},
						{
							"key": "dt_venda",
							"value": "2020-04-14"
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "Installments",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/v1/fpay/installments?nu_referencia=REF0001&nu_venda=38425-uGet3-2KFMj&page=0&per_page=10&dt_venda=2020-04-14",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"v1",
						"fpay",
						"installments"
					],
					"query": [
						{
							"key": "nu_referencia",
							"value": "REF0001"
						},
						{
							"key": "nu_venda",
							"value": "38425-uGet3-2KFMj"
						},
						{
							"key": "page",
							"value": "0"
						},
						{
							"key": "per_page",
							"value": "10"
						},
						{
							"key": "dt_venda",
							"value": "2020-04-14"
						}
					]
				}
			},
			"response": []
		}
	]
}

添加 JSON 后，点击 Continue，集合将被导入。

完成此操作后，您需要创建一个变量 URL，包含您应用程序的基本路由，之后可以请求端点。

测试