Skip to main content

How to Use

本ドキュメントでは、外部公開APIの基本的な使い方を解説しています。

概要​

外部公開APIは、コングラントのプロダクト外でコングラントのプロジェクト、決済、継続契約、サポーターなどの情報を管理るための、Application Programming Interfaceです。

バージョン​

Version 1

事前準備​

  • 外部公開APIを利用するためには、コングラント運営側に連携して利用許可を受けることが必須になります
  • 許可済みの上で、外部公開APIキーをコングラントアプリの基本設定 -> APIキー画面から登録します
  • 登録したAPIキーを利用して外部公開APIの各APIを利用します
  • ベースURIは、https://global-api.congrant.com です

APIキーの種類​

外部公開APIには シークレットキー と 公開キー（Publishable Key） の2種類があります。

種別用途アクセス可能なAPI
シークレットキーサーバーサイドのみ発行時に選択したスコープのAPI
公開キーブラウザJS可/api/v1/projects のみ

詳細は APIキーの種類 をご参照ください。

APIキーの利用​

  • 各APIの実行時には、HTTPリクエストヘッダに以下のようにトークンを指定します
Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX(発行したキー)

API一覧​

プロジェクト関連API​

NoAPI NameAPI名MethodURI目的versionAPIキーの利用
1GetProjectプロジェクトの数値GET/api/v1/projectsプロジェクト別寄付情報を取得v1〇

決済関連API​

NoAPI NameAPI名MethodURI目的versionAPIキーの利用
2GetPayment決済の数値GET/api/v1/payments決済情報の取得v1〇

継続契約関連API​

NoAPI NameAPI名MethodURI目的versionAPIキーの利用
3GetRecurring継続契約の数値GET/api/v1/recurrings継続契約情報の取得v1〇

サポーター関連API​

NoAPI NameAPI名MethodURI目的versionAPIキーの利用
4GetSupporterサポーターの数値GET/api/v1/supportersサポーター情報の取得v1〇