board APIの基本
boardに下記の機能はありません。
- Webhook
- ビジネスロジックを構成する機能
従って、外部システムからboardのAPIを叩きに行くのが唯一の連携パターンとなります。
boardのER図
boardのERDは下記の通り。
個人的に注意すべきだと思うのは以下の二つです。
- board案件においてboard顧客が必須項目であること
- 見積書・発注書・発注請書は1board案件1つまでであること
外部システムからboard案件を自動生成する場合、予め外部システム側で取引先情報をboard顧客id付きで管理しておく必要があります。
また、帳票の発行を前提としてシステム連携を行う場合、帳票発行の制限を明確に把握しておく必要があります。
board APIの叩き方
board APIドキュメントに記載されている通りに設定すれば問題ありません。
①boardのAPI設定からAPIトークンを発行する
②トークンごとに必要な権限を付与する
③APIを叩く
- EndPoint：https://api.the-board.jp/v1/projects
- Header1：Content-Type: application/json
- Header2：Authorization: Bearer トークン
- Header3：キー
- Body：APIドキュメントに記載のJSPN
うまくいかない場合
個人的な経験としては、以下のミスが多かったです。とはいえ、エラー文に従って修正していけば問題箇所の特定に困ることはありませんでした。
- APIトークンで必要な権限を付与できていない
- エンドポイントを間違えている
- bodyの形式（JSONの形式）が誤っている
一番多いパターンはエンドポイントの指定ミスかと思います。
すなわち、board案件（https://api.the-board.jp/v1/projects）を作成したいにもかかわらず、board顧客のエンドポイント（https://api.the-board.jp/v1/clients）叩いてしまっているパターンなどです。