クライアントライブラリ

PocketSign Verify API はConnect プロトコルに対応しています。 Connect プロトコルを使用して API を呼び出すためのクライアントライブラリは、以下の言語向けに提供しています。

Go
TypeScript/JavaScript (Web/Node.js)
Kotlin
Swift

クライアントライブラリはBuf Schema Registryから入手できます。

これら以外の言語から利用する場合は、その他の呼び出し方法を参照してください。

セットアップ

Go
TypeScript
Kotlin
Swift

Buf Schema Registry / Remote packagesのドキュメントおよびConnect for Goのドキュメントもご参照ください。

Go modules のセットアップを行います。

シェルで実行

go mod init docs.p8n.app/example-project

クライアントライブラリおよび依存ライブラリをインストールします。

シェルで実行
go get connectrpc.com/connect@latest
go get google.golang.org/protobuf@latest
go get buf.build/gen/go/pocketsign/apis/connectrpc/go@latest
go get buf.build/gen/go/pocketsign/apis/protocolbuffers/go@latest

以下のようなサンプルプログラムを作成します。ファイル名は main.go とします。

main.go
package main

import (
	"context"
	"fmt"
	"log"
	"net/http"

	"buf.build/gen/go/pocketsign/apis/connectrpc/go/pocketsign/verify/v2/verifyv2connect"
	verifyv2 "buf.build/gen/go/pocketsign/apis/protocolbuffers/go/pocketsign/verify/v2"
	"connectrpc.com/connect"
)

var (
	// APIエンドポイントを指定します。この値は環境によって異なります。
	baseUrl = "https://verify.mock.p8n.app"

	// Verify APIのトークンです。ご自身のトークンに置き換えてください。
	token = "<YOUR_API_TOKEN>"
)

func run() error {
	// リクエストを作成します。
	request := connect.NewRequest(&verifyv2.ListCertificatesRequest{})

	// リクエストにAPIトークンを設定します。
	request.Header().Set("Authorization", "Bearer "+token)

	// APIクライアントを作成します。
	client := verifyv2connect.NewCertificateServiceClient(http.DefaultClient, baseUrl)

	// リクエストを送信します。
	response, err := client.ListCertificates(context.Background(), request)
	if err != nil {
		return err
	}

	// レスポンスを表示します。
	fmt.Printf("%+v\n", response)
	return nil
}

func main() {
	if err := run(); err != nil {
		log.Fatalln(err)
	}
}

プログラムを実行します。

シェルで実行

go run main.go

エラーが表示されなければ、準備完了です。 API を使用して開発を進めましょう 🚀

Buf Schema Registry / Remote packagesのドキュメントおよびConnect for Webのドキュメントもご参照ください。

プロジェクトのセットアップを行います。

シェルで実行
mkdir connect-example
cd connect-example
npm init -y

クライアントライブラリおよび依存ライブラリをインストールします。

シェルで実行
npm config set @buf:registry https://buf.build/gen/npm/v1
npm install @buf/pocketsign_apis.bufbuild_es @buf/pocketsign_apis.connectrpc_es @connectrpc/connect @connectrpc/connect-web typescript

以下のようなサンプルプログラムを作成します。ファイル名は main.ts とします。

main.ts
import { CertificateService } from '@buf/pocketsign_apis.connectrpc_es/pocketsign/verify/v2/certificate_connect';
import { createPromiseClient } from '@connectrpc/connect';
import { createConnectTransport } from '@connectrpc/connect-Web';

// APIエンドポイントを指定します。この値は環境によって異なります。
const BASE_URL = 'https://verify.mock.p8n.app';

// Verify APIのトークンです。ご自身のトークンに置き換えてください。
const TOKEN = '<YOUR_API_TOKEN>';

const main = async () => {
  // APIクライアントを作成します。
  const client = createPromiseClient(
    CertificateService,
    createConnectTransport({
      baseUrl: BASE_URL,
      useBinaryFormat: true,
      interceptors: [
        (next) => async (request) => {
          // リクエストにAPIトークンを設定します。
          request.header.set('Authorization', `Bearer ${TOKEN}`);
          return await next(request);
        },
      ],
    })
  );

  // リクエストを送信します。
  const response = await client.listCertificates({});

  // レスポンスを表示します。
  console.log(response.toJsonString({ prettySpaces: 2 }));
};

void main();

プログラムを実行します。

シェルで実行

npx tsx main.ts

エラーが表示されなければ、準備完了です。 API を使用して開発を進めましょう 🚀

その他の呼び出し方法

Connect プロトコルは、gRPC および gRPC-Web をサポートするほか、通常の HTTP ベース API としても利用できます。クライアントライブラリが提供されない言語であっても、上記の互換プロトコルを利用して API を呼び出すことができます。詳しくはライブラリを使用せずに呼び出すを参照してください。

セットアップ​

その他の呼び出し方法​

セットアップ

その他の呼び出し方法