POST公開中api-shortUrl-create

短縮URL生成

短縮URL生成APIサービスを提供し、開発者が短縮URL関連情報を迅速に生成し、業務システムへ統合できるよう支援します。

導入ドキュメント

短縮URL生成APIの仕様

短縮URL生成APIは、開発者がシステム内で短縮URL生成に関する処理を迅速に完了できるよう支援します。構造化された結果を返すため、業務システムへの統合、自動化された呼び出し、システム連携などのシナリオに適しています。

適用シナリオ

内部システム、SaaSプラットフォーム、自動化ワークフロー、または運用管理画面への「短縮URL生成」機能の組み込みをサポートします。
安定した呼び出し、標準化されたレスポンス、およびオーケストレーション可能なAPI機能が必要な業務シナリオに適しています。
全体的な統合の安定性を向上させるため、リクエストの頻度制御、失敗時のリトライ、および結果のキャッシュ戦略と組み合わせることを推奨します。

導入時の推奨事項

導入前に、リクエストパラメータの形式、認証方法、およびエラーコードの処理ロジックを確認してください。
高頻度で「生成」を行うシナリオでは、ログ追跡、タイムアウト制御、およびべき等性の処理を適切に行うことを推奨します。
結果をリスク管理や自動意思決定に使用する場合は、APIのレスポンスのみに単一依存するのではなく、ビジネスルールと組み合わせた二次判断を行うことを推奨します。

実装サンプルコード

Shell、Python、Go、Java、PHP の呼び出し例をまとめ、既存プロジェクトに組み込みやすくしています。

リクエスト例

{
  "longUrl": "https://www.toolkk.com/apis/idcard-validate",
  "length": 6
}

レスポンス例

{
  "code": "SUCCESS",
  "message": "success",
  "data": {
    "shortUrl": "https://t.kk/abc123",
    "longUrl": "https://www.toolkk.com/apis/idcard-validate"
  }
}

リクエスト項目

以下の項目はサンプル JSON から自動抽出した参考情報です。

パス	型	サンプル値
longUrl	string	https://www.toolkk.com/apis/idcard-validate
length	number	6

レスポンス項目

以下の項目はサンプル JSON から自動抽出した参考情報です。

パス	型	サンプル値
code	string	SUCCESS
message	string	success
data	object	{...}
data.shortUrl	string	https://t.kk/abc123
data.longUrl	string	https://www.toolkk.com/apis/idcard-validate

curl --request POST \ --url 'https://openapi.toolkk.com/v1/api-shortUrl-create' \ --header 'Content-Type: application/json' \ --header 'X-API-Key: YOUR_API_KEY' \ --data '{\n "longUrl": "https://www.toolkk.com/apis/idcard-validate",\n "length": 6\n}'

import os import requests url = "https://openapi.toolkk.com/v1/api-shortUrl-create" payload = { "longUrl": "https://www.toolkk.com/apis/idcard-validate", "length": 6 } headers = { "Content-Type": "application/json", "X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"), } response = requests.request("POST", url, headers=headers, json=payload, timeout=30) response.raise_for_status() print(response.json())

package main import ( "bytes" "fmt" "io" "net/http" ) func main() { endpoint := "https://openapi.toolkk.com/v1/api-shortUrl-create" payload := []byte("{\n \"longUrl\": \"https://www.toolkk.com/apis/idcard-validate\",\n \"length\": 6\n}") req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload)) if err != nil { panic(err) } req.Header.Set("Content-Type", "application/json") req.Header.Set("X-API-Key", "YOUR_API_KEY") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() body, err := io.ReadAll(resp.Body) if err != nil { panic(err) } fmt.Println(string(body)) }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class ToolkkExample { public static void main(String[] args) throws Exception { String payload = "{\n \"longUrl\": \"https://www.toolkk.com/apis/idcard-validate\",\n \"length\": 6\n}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://openapi.toolkk.com/v1/api-shortUrl-create")) .method("POST", HttpRequest.BodyPublishers.ofString(payload)) .header("Content-Type", "application/json") .header("X-API-Key", "YOUR_API_KEY") .build(); HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } }

<?php $endpoint = 'https://openapi.toolkk.com/v1/api-shortUrl-create'; $payload = "{\n \"longUrl\": \"https://www.toolkk.com/apis/idcard-validate\",\n \"length\": 6\n}"; $ch = curl_init($endpoint); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'X-API-Key: YOUR_API_KEY', ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); if ($response === false) { throw new RuntimeException(curl_error($ch)); } curl_close($ch); echo $response;

短縮URL生成

導入ドキュメント