How to Use
本ドキュメントでは、外部公開APIの基本的な使い方を解説しています。
概要
外部公開APIは、コングラントのプロダクト外でコングラントのプロジェクト、決済、継続契約、サポーターなどの情報を管理るための、Application Programming Interfaceです。
バージョン
Version 1
事前準備
- 外部公開APIを利用するためには、コングラント運営側に連携して利用許可を受けることが必須になります
- 許可済みの上で、外部公開APIキーをコングラントアプリの基本設定 -> APIキー画面から登録します
- 登録したAPIキーを利用して外部公開APIの各APIを利用します
- ベースURIは、https://global-api.congrant.com です
APIキーの利用
- 各APIの実行時には、HTTPリクエストヘッダに以下のようにトークンを指定します
Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX(発行したキー)
API一覧
プロジェクト関連API
| No | API Name | API名 | Method | URI | 目的 | version | APIキーの利用 |
|---|---|---|---|---|---|---|---|
| 1 | GetProject | プロジェクトの数値 | GET | /api/v1/projects | プロジェクト別寄付情報を取得 | v1 | 〇 |
決済関連API
| No | API Name | API名 | Method | URI | 目的 | version | APIキーの利用 |
|---|---|---|---|---|---|---|---|
| 2 | GetPayment | 決済の数値 | GET | /api/v1/payments | 決済情報の取得 | v1 | 〇 |
継続契約関連API
| No | API Name | API名 | Method | URI | 目的 | version | APIキーの利用 |
|---|---|---|---|---|---|---|---|
| 3 | GetRecurring | 継続契約の数値 | GET | /api/v1/recurrings | 継続契約情報の取得 | v1 | 〇 |
サポーター関連API
| No | API Name | API名 | Method | URI | 目的 | version | APIキーの利用 |
|---|---|---|---|---|---|---|---|
| 4 | GetSupporter | サポーターの数値 | GET | /api/v1/supporters | サポーター情報の取得 | v1 | 〇 |