README

一个简单的 Laravel 5 Facade，用于轻松检索 typeform 响应以及验证/注册/注销 webhook。

安装

要求

php: >=8.0

Composer

composer require "RosiersRobin/laravel-typeform"

服务提供者

RosiersRobin\LaravelTypeForm\TypeFormServiceProvider 默认自动发现并注册，但如果你想手动注册

将服务提供者在 config/app.php 中添加

'providers' => [
    /*
     * Package Service Providers...
     */
    RosiersRobin\LaravelTypeForm\TypeFormServiceProvider::class,
]

外观

TypeForm 外观也默认自动发现，但如果你想手动添加

将外观添加到 config/app.php 中

'aliases' => [
    ...
    'TypeForm' => RosiersRobin\LaravelTypeForm\TypeFormFacade::class,
]

配置

要发布配置，请运行 vendor publish 命令

php artisan vendor:publish --provider="RosiersRobin\LaravelTypeForm\TypeFormServiceProvider"

config/typeform.php 的示例

<?php
return [
    'debug' => false,
    'token' => env('TYPEFORM_TOKEN'),
    'headers' => [],
    'base_uri' => 'https://api.typeform.com/',
    'webhook' => [
        'base_uri' => env('TYPEFORM_WEBHOOK_BASE_URI', null), // if none app.url is used
        'uri' => env('TYPEFORM_WEBHOOK_URI', '/api/webhook/typeform'),
        'tag' => env('TYPEFORM_WEBHOOK_TAG', null),
        'secret' => env('TYPEFORM_WEBHOOK_SECRET', null),
        'verify_ssl' => env('TYPEFORM_WEBHOOK_VERIFY_SSL', true),
    ],
];

TYPEFORM_TOKEN 是必填项，以便检索所有数据。

入门指南

强烈建议使用外观，因为所有示例都将使用它。

use TypeForm;

表单

检索所有表单

$formChunks = TypeForm::getFormsByChunk();
foreach ($formChunks as $forms) {
    foreach ($forms['items'] as $form) {
        Log::info($form['id']);
    }
}

以下是所有请求参数的描述。

检索一个表单的问题

$jsonForm = TypeForm::getForm($this->formSlug);

foreach ($jsonForm['fields'] as $item) {
    // $item is a question / section
    Log::debug($item)

    if ($item['type'] == 'group') {
        foreach ($item['properties']['fields'] as $subItem) {
            Log::debug($subItem);
        }
    }
}

以下是所有请求参数的描述。

响应

检索一个表单的所有完成响应

$params = ['completed' => true];

foreach (TypeForm::getResponsesByChunk("MyFormId", $params) as $responses) {
    /**
        1 response = 1 submitted forms
        Each response contains all answers (unordered)
     */
    foreach ($responses['items'] as $jsonResponse) {
        $submitted_at = Carbon::parse($jsonResponse['submitted_at']);
        $id = $jsonResponse['token'];

        foreach ($jsonResponse['answers'] as $jsonAnswer) {
            /**
             Store your answers ?
             */
        }
    }
}

以下是 JSON 响应解释及其所有参数。

Webhooks

如果你在配置中指定了密钥（TYPEFORM_WEBHOOK_SECRET），此包将管理密钥。
以下是关于 webhook 安全性的描述。

为表单注册 webhook

TypeForm::registerWebhook('MyFormId');

删除/注销表单的 webhook

TypeForm::deleteWebhook('MyFormId');

在控制器中验证 webhook 调用

<?php

namespace App\Http\Controllers\API;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use TypeForm;

class TypeFormController extends Controller
{
    public function __invoke(Request $request)
    {
        TypeForm::validatePayload($request);
        
        $formId = $request->form_response['form_id'] ?? null;
        abort_if($formId == null, 403);

        /**
            Do your stuff here
        */

        return ['ok'];
    }
}

rosiersrobin / laravel-typeform

维护者

详细信息