はじめに
VAT検証エンドポイント
VAT番号の真正性を検証し、国、企業名、住所、登録詳細を含む包括的な企業情報を取得します。
VAT計算エンドポイント
国別の規制、購入タイプ、取引金額に基づいてVAT準拠の価格を計算し、正確な財務計算を実現します。
VATカテゴリエンドポイント
特定の国における現在のVAT税率と税カテゴリにアクセスし、現地の税規制へのコンプライアンスを確保します。
RESTアーキテクチャ
VAT検証APIはRESTの原則に従い、予測可能なリソース指向のURLと標準的なHTTPステータスコードを使用して、シームレスな統合とエラーハンドリングを実現します。すべてのAPIエンドポイントは末尾スラッシュ(/)で終わる必要があり、GETリクエストのみをサポートします。HTTPSセキュリティ
すべてのAPI通信はTLS 1.2以上の暗号化プロトコルで保護され、データの完全性とプライバシーが確保されます。APIバージョン管理
VAT検証APIはバージョン管理により後方互換性を維持しており、現在はバージョン1で稼働し、将来の機能強化が計画されています。認証
APIキーはVAT検証APIにアクセスするための唯一の認証情報です。Cleariflowの各サービスには固有のキーが必要であり、異なるAPI間で安全かつ分離されたアクセスが保証されます。APIはすべてのユーザーに公平な利用を確保するため、レート制限を実装しています。レスポンスおよびエラーコード
リクエストが失敗した場合、APIは効果的なトラブルシューティングのために、特定のコードと説明を含む構造化されたJSONエラーレスポンスを返します。| Code | Type | Details |
|---|---|---|
| 200 | OK | すべてが想定どおりに動作しました。 |
| 400 | Bad request | 不正なリクエストです。 |
| 401 | Unauthorized | リクエストが受け付けられませんでした。通常はAPIキーが欠落しているか不正です。 |
| 422 | Quota reached | APIクレジット不足のためリクエストが中止されました。(無料プラン) |
| 429 | Too many requests | 許可された秒あたりのリクエスト数に達したためリクエストが中止されました。無料プランでは1秒あたり1リクエストに制限されています。 |
| 500 | Internal server error | サーバー側のエラーによりリクエストを完了できませんでした。 |
| 503 | Service unavailable | サーバーが利用できませんでした。 |
国コード
以下はVATエンドポイントがサポートする国のリストです。| Country code | Country name |
|---|---|
| AT | Austria |
| BE | Belgium |
| BG | Bulgaria |
| CY | Cyprus |
| CZ | Czech Republic |
| DE | Germany |
| DK | Denmark |
| EE | Estonia |
| FI | Finland |
| FR | France |
| GB | United Kingdom |
| GR | Greece |
| HR | Croatia |
| HU | Hungary |
| IE | Ireland |
| IT | Italy |
| LT | Lithuania |
| LU | Luxembourg |
| LV | Latvia |
| MT | Malta |
| NL | The Netherlands |
| PL | Poland |
| PT | Portugal |
| RO | Romania |
| SE | Sweden |
| SI | Slovenia |
| SK | Slovakia |