README

Flipp – 图像生成 API

Flipp 是一个允许您创建独特预览图像的服务。通过 REST API 或使用签名 URL 生成社交媒体视觉内容。

此包是 Flipp API 的官方封装。要开始使用它，您需要创建免费账户并获取 API 密钥。

安装

composer require useflipp/client

用法

同步生成图像

以下是一个使用 API 同步生成图像的快速示例。

use Flipp\Client\Client as FlippClient;

FlippClient::make($apiKey)
  ->setTemplate($templateId)
  ->setField('title', 'Dynamic Value')
  ->getImage(); // returns generated image URL

请注意，根据模板复杂度和连接质量，图像生成过程可能需要 2-3 秒。

签名 URL

如果您不想同步执行请求，可以使用编码参数生成签名 URL。这不需要 API 调用，并且图像将在第一次 HTTP 调用（页面访问）期间生成。

use Flipp\Client\Client as FlippClient;

FlippClient::make($apiKey)
  ->setTemplate($templateId)
  ->setField('title', 'Dynamic Value')
  ->getSignedUrl(); // returns signed URL

动态值和样式

您还可以设置动态字段值及其样式。此选项仅适用于 API 调用。

FlippClient::make($apiKey)
  ->setTemplate($templateId)
  ->setField('title', 'Dynamic Value', [
    'color' => '#ff00ff',
  ])
  ->setField('square', null, [
    'backgroundColor' => '#aa3f3f'
  ]);

回退 URL

使用 Flipp，您还可以为无法直接集成 Flipp 的链接创建回退 URL，带有社交媒体预览。

FlippClient::make($apiKey)
  ->setTemplate($templateId)
  ->setField('title', 'Meta Title') // optional
  ->setField('description', 'Meta Description') // optional
  ->getLink($url); // returns short link

此方法返回一个可能分享在社交媒体上的短链接。您可以指定自定义标题和描述，这些将用于模板以及生成页面的元数据。如果您不提供数据，这些值将从提供的外部 URL 中获取。

useflipp / client

维护者

详细信息