Webhook エンドポイントを作成
POST/v1/endpoints
契約 v1 / 1.0.0 62 / 2026-10-10
このページの内容
プロジェクトの HTTPS 受信先を追加します。アカウントあたり有効なエンドポイントは最大 20 件です。同じ API キーで同じプロジェクトの同じ URL を再登録しても配信は重複しません。200 と既存 ID が返され、シークレットは含まれません。201 の後にシークレットを保存してください。上限到達時は再登録でも 402 を返す場合があります。
キー権限:webhooks / write。
リクエスト本文
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
url | string | はい | 公開 HTTPS Webhook 受信先の URL。ローカルアドレスとプライベートアドレスは拒否されます。uri、pattern: ^https:// |
label | string | いいえ | 任意の送信先ラベル。 |
project | string | いいえ | プロジェクト ID。省略時はキーのプロジェクト、またはアカウントの既定のプロジェクトを使用します。 |
application/json
{
"project": "1002",
"url": "https://merchant.example/webhooks/cryptanio",
"label": "Orders"
}リクエスト例
サンプルはお客様のアカウントで実際の操作を行います。コードで指定された環境変数を設定してください。キーは秘密に保管します。書き込みリクエストは自動再試行されません。
Shell / cURL
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
: "${CRYPTANIO_PROJECT_ID:?Set CRYPTANIO_PROJECT_ID}"
json_string() {
local text="$1" char code index output='"'
for ((index=0; index<${#text}; index++)); do
char="${text:index:1}"
case "$char" in
'"'|'\') output+="\\$char" ;;
*) printf -v code '%d' "'$char"
if ((code < 32)); then printf -v char '\\u%04x' "$code"; fi
output+="$char" ;;
esac
done
printf '%s"' "$output"
}
response_file="$(mktemp)"
trap 'rm -f "$response_file"' EXIT
transfer_status=0
http_status="$(curl \
--silent --show-error --max-time 30 --request POST \
--header "Authorization: Bearer $CRYPTANIO_API_KEY" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-binary '{"project":'"$(json_string "$CRYPTANIO_PROJECT_ID")"',"url":"https://merchant.example/webhooks/cryptanio","label":"Orders"}' \
"https://api.cryptanio.com/v1/endpoints" \
--output "$response_file" --write-out '%{http_code}')" || transfer_status=$?
if [[ "$http_status" == 2?? ]]; then
cat "$response_file"
exit "$transfer_status"
fi
printf 'HTTP %s\n' "$http_status" >&2
cat "$response_file" >&2
exit 1
Go
// Go; standard library only. Run: go run request.go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"time"
)
func env(name string) string {
value := os.Getenv(name)
if value == "" { fmt.Fprintln(os.Stderr, "Set", name); os.Exit(1) }
return value
}
func run() error {
path := "/v1/endpoints"
endpoint, err := url.Parse("https://api.cryptanio.com" + path)
if err != nil { return err }
query := endpoint.Query()
endpoint.RawQuery = query.Encode()
var payload map[string]any
if err := json.Unmarshal([]byte("{\"project\":\"1002\",\"url\":\"https://merchant.example/webhooks/cryptanio\",\"label\":\"Orders\"}"), &payload); err != nil { return err }
payload["project"] = env("CRYPTANIO_PROJECT_ID")
body, err := json.Marshal(payload)
if err != nil { return err }
request, err := http.NewRequest("POST", endpoint.String(), bytes.NewReader(body))
if err != nil { return err }
request.Header.Set("Authorization", "Bearer " + env("CRYPTANIO_API_KEY"))
request.Header.Set("Accept", "application/json")
request.Header.Set("Content-Type", "application/json")
client := &http.Client{Timeout: 30 * time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { return err }
defer response.Body.Close()
if response.StatusCode < 200 || response.StatusCode >= 300 {
body, err := io.ReadAll(response.Body)
if err != nil { return err }
return fmt.Errorf("HTTP %d: %s", response.StatusCode, body)
}
_, err = io.Copy(os.Stdout, response.Body)
return err
}
func main() {
if err := run(); err != nil { fmt.Fprintln(os.Stderr, err); os.Exit(1) }
}
Rust
// Cargo.toml dependencies:
// reqwest = { version = "=0.12.24", features = ["blocking", "json"] }
// serde_json = "=1.0.145"
use std::{error::Error, io, time::Duration};
use reqwest::{blocking::Client, redirect::Policy, Method, Url};
fn env(name: &str) -> Result<String, Box<dyn Error>> {
let value = std::env::var(name)?;
if value.is_empty() { return Err(format!("Set {name}").into()); }
Ok(value)
}
fn run() -> Result<(), Box<dyn Error>> {
let mut url = Url::parse("https://api.cryptanio.com")?;
{
let mut segments = url.path_segments_mut().map_err(|_| "Invalid base URL")?;
segments.clear();
segments.push("v1");
segments.push("endpoints");
}
let client = Client::builder().timeout(Duration::from_secs(30)).redirect(Policy::none()).build()?;
let request = client.request(Method::POST, url)
.header("Authorization", format!("Bearer {}", env("CRYPTANIO_API_KEY")?))
.header("Accept", "application/json".to_owned())
.header("Content-Type", "application/json".to_owned());
let mut body: serde_json::Value = serde_json::from_str("{\"project\":\"1002\",\"url\":\"https://merchant.example/webhooks/cryptanio\",\"label\":\"Orders\"}")?;
body["project"] = serde_json::Value::String(env("CRYPTANIO_PROJECT_ID")?);
let request = request.json(&body);
let mut response = request.send()?;
let status = response.status();
if !status.is_success() { return Err(format!("HTTP {}: {}", status.as_u16(), response.text()?).into()); }
io::copy(&mut response, &mut io::stdout())?;
Ok(())
}
fn main() {
if let Err(error) = run() { eprintln!("{error}"); std::process::exit(1); }
}
PHP
<?php
// PHP 8 with the cURL extension. Run this on your server.
function env(string $name): string {
$value = getenv($name);
if ($value === false || $value === '') throw new RuntimeException('Set ' . $name);
return $value;
}
try {
$path = '/v1/endpoints';
$query = [
];
$url = 'https://api.cryptanio.com' . $path . ($query ? '?' . http_build_query($query, '', '&', PHP_QUERY_RFC3986) : '');
$headers = [
'Authorization: ' . 'Bearer ' . env('CRYPTANIO_API_KEY'),
'Accept: ' . 'application/json',
'Content-Type: ' . 'application/json',
];
$body = json_decode('{"project":"1002","url":"https://merchant.example/webhooks/cryptanio","label":"Orders"}', true, 512, JSON_THROW_ON_ERROR);
$body['project'] = env('CRYPTANIO_PROJECT_ID');
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_POSTFIELDS => json_encode($body, JSON_THROW_ON_ERROR),
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($status < 200 || $status >= 300) throw new RuntimeException('HTTP ' . $status . ': ' . $response);
echo $response;
} catch (Throwable $error) {
fwrite(STDERR, $error->getMessage() . PHP_EOL);
exit(1);
}
Python
# Python 3; standard library only.
import json
import os
import sys
from urllib.error import HTTPError, URLError
from urllib.parse import quote, urlencode
from urllib.request import HTTPRedirectHandler, Request, build_opener
def env(name):
result = os.environ.get(name)
if not result:
raise ValueError("Set " + name)
return result
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
try:
path = "/v1/endpoints"
query = {
}
url = "https://api.cryptanio.com" + path + ("?" + urlencode(query) if query else "")
headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "application/json",
"Content-Type": "application/json",
}
body = json.loads("{\"project\":\"1002\",\"url\":\"https://merchant.example/webhooks/cryptanio\",\"label\":\"Orders\"}")
body["project"] = env("CRYPTANIO_PROJECT_ID")
data = json.dumps(body).encode("utf-8")
request = Request(url, data=data, headers=headers, method="POST")
with build_opener(NoRedirect()).open(request, timeout=30) as response:
if not 200 <= response.status < 300:
raise ValueError("HTTP " + str(response.status))
sys.stdout.buffer.write(response.read())
except HTTPError as error:
print("HTTP " + str(error.code) + ": " + error.read().decode("utf-8", errors="replace"), file=sys.stderr)
sys.exit(1)
except (ValueError, URLError, OSError) as error:
print(str(error), file=sys.stderr)
sys.exit(1)
Node.js
// Node.js 18+. Run on your server, never in a browser.
const env = name => {
const result = process.env[name];
if (!result) throw new Error(`Set ${name}`);
return result;
};
try {
let path = "/v1/endpoints";
const url = new URL(path, "https://api.cryptanio.com");
const headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "application/json",
"Content-Type": "application/json",
};
const body = {
"project": "1002",
"url": "https://merchant.example/webhooks/cryptanio",
"label": "Orders"
};
body["project"] = env("CRYPTANIO_PROJECT_ID");
const response = await fetch(url, {
method: "POST", headers, redirect: "manual",
signal: AbortSignal.timeout(30_000), body: JSON.stringify(body),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
if (response.body) {
for await (const chunk of response.body) process.stdout.write(chunk);
}
} catch (error) {
console.error(error.message);
process.exitCode = 1;
}
応答とエラー
200 エンドポイントは登録済みです。シークレットは省略されます。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | 内部構造を持たない識別子。文字列のまま保持してください。 minLength: 1 |
project_id | string | はい | 内部構造を持たない識別子。文字列のまま保持してください。 minLength: 1 |
sandbox | boolean | はい | テスト用の送信先を示すフラグ。公開の顧客向けサンドボックスが利用可能であることを意味しません。 |
url | string | はい | 送信先の HTTPS URL。uri |
label | string | いいえ | ラベル。 |
secret | string | いいえ | 署名用シークレット。新規作成時にのみ返され、一覧取得や再登録では返されません。 |
source | string | はい | api、dashboard、browser など、送信先の作成方法。新しい値が追加される場合があります。 |
created_at | string | はい | RFC 3339 形式の UTC 日時。date-time |
200 application/json
{
"id": "2200",
"project_id": "1002",
"sandbox": true,
"url": "https://merchant.example/webhooks/cryptanio",
"source": "api",
"created_at": "2026-10-06T10:00:00Z"
}201 成功応答。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | 内部構造を持たない識別子。文字列のまま保持してください。 minLength: 1 |
project_id | string | はい | 内部構造を持たない識別子。文字列のまま保持してください。 minLength: 1 |
sandbox | boolean | はい | テスト用の送信先を示すフラグ。公開の顧客向けサンドボックスが利用可能であることを意味しません。 |
url | string | はい | 送信先の HTTPS URL。uri |
label | string | いいえ | ラベル。 |
secret | string | いいえ | 署名用シークレット。新規作成時にのみ返され、一覧取得や再登録では返されません。 |
source | string | はい | api、dashboard、browser など、送信先の作成方法。新しい値が追加される場合があります。 |
created_at | string | はい | RFC 3339 形式の UTC 日時。date-time |
201 application/json
{
"id": "2200",
"project_id": "1002",
"sandbox": true,
"url": "https://merchant.example/webhooks/cryptanio",
"source": "api",
"created_at": "2026-10-06T10:00:00Z"
}400 無効なリクエスト(bad_request、unsupported_asset)。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
400 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}401 有効で使用可能な API キーがありません(unauthorized)。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
401 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}402 リソースの上限に達しました(limit_reached)。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
402 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}403 キーが操作、プロジェクト、サービス、IP を許可していないか、メールアドレスが未確認です。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
403 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}409 状態の競合、再試行パラメーターの不一致、または支払いリソースの上限(conflict、limit_reached、service_inactive)。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
409 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}429 リクエストが多すぎます(rate_limited)。Retry-After の後に再試行してください。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
429 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}500 内部エラー(internal)。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
500 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}503 一時的に利用できません(unavailable)。バックオフを設けて再試行してください。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |
503 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}入れ子のオブジェクト
Endpoint
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | 内部構造を持たない識別子。文字列のまま保持してください。 minLength: 1 |
project_id | string | はい | 内部構造を持たない識別子。文字列のまま保持してください。 minLength: 1 |
sandbox | boolean | はい | テスト用の送信先を示すフラグ。公開の顧客向けサンドボックスが利用可能であることを意味しません。 |
url | string | はい | 送信先の HTTPS URL。uri |
label | string | いいえ | ラベル。 |
secret | string | いいえ | 署名用シークレット。新規作成時にのみ返され、一覧取得や再登録では返されません。 |
source | string | はい | api、dashboard、browser など、送信先の作成方法。新しい値が追加される場合があります。 |
created_at | string | はい | RFC 3339 形式の UTC 日時。date-time |
ID
内部構造を持たない識別子。形式は保証されないため、数値に変換しないでください。
string 不透明な識別子。形式は保証されていません。数値に変換しないでください。
EndpointRequest
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
url | string | はい | 公開 HTTPS Webhook 受信先の URL。ローカルアドレスとプライベートアドレスは拒否されます。uri、pattern: ^https:// |
label | string | いいえ | 任意の送信先ラベル。 |
project | string | いいえ | プロジェクト ID。省略時はキーのプロジェクト、またはアカウントの既定のプロジェクトを使用します。 |
Error
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
error | object | はい |