「システムをAPIでつなげば楽になりますよ」と言われたが、そもそもAPIが何か分からない。結論から言うと、API連携とはシステムが用意している「外からつなぐ口」を使って、2つのシステムの間でデータを自動でやり取りさせることです。頼む前に手元で確かめるのは、相手にAPIがあるか、今の料金プランで使えるか、呼べる回数に上限がないかの3点です。この記事では、それが何を変えるのか、費用がどこで決まるのか、APIがないときはどうするのかを書きます。
連携の方法そのものの比べ方(API、CSV、データベース直結、画面操作の自動化)は、基幹システムの連携|4つの方法とAPIがない場合の選び方に書きました。この記事は、API連携そのものの入門と頼み方に絞ります。
API連携とは、どういうことですか?
APIは、システムの提供元が「外のプログラムからこの操作をしてよい」と決めて用意した窓口です。人が画面でボタンを押す代わりに、別のプログラムがその窓口に「このお客様のデータをください」「この注文を登録してください」と頼みます。
たとえば、受注の画面で入力した内容を、人がもう一度会計ソフトに打ち直している会社を考えます。API連携でつなぐと、受注を登録した時点で、プログラムが会計ソフトの窓口に同じ内容を渡します。打ち直しがなくなり、転記ミスも起きません。
ここで大事なのは、APIはシステムを作った側が用意するものという点です。つなぎたい側が勝手に作れるものではありません。だから「APIがあるか」が最初の確認になります。
API連携でできることは何ですか?
大きく3つに分けられます。
| できること | 中身 | 具体例 |
|---|---|---|
| 読む | 相手のシステムにあるデータを取ってくる | 取引先の一覧、注文の状況を毎朝取り込む |
| 書く | 相手のシステムにデータを登録・更新する | 受注内容を会計ソフトや在庫管理に入れる |
| 両方向で合わせる | 読む・書くを組み合わせ、2つのシステムの内容をそろえる | 顧客管理の内容を、別の社内システムにも反映する |
どこまでできるかは、相手のAPIがどの操作を許しているかで決まります。読むだけを許しているAPIもあれば、書き込みまで許しているAPIもあります。「つなげる」と言っても、「読むだけ」なのか「書き込みもできる」のかで、できる業務が変わります。
頼む前に確かめることは何ですか?
API連携には、3つの前提があります。見積もりを頼む前に、この3つを手元で確かめておくと話が早く進みます。
- 相手のシステムにAPIがあるか。提供元の資料や管理画面に「API」「外部連携」の項目があるか、問い合わせて確かめます。ない場合は、後ろの「APIがないときの代わりの方法」に進みます
- 今の料金プランでAPIを使えるか。サービスによっては、プランごとにAPIの使える範囲が違う、または追加の利用料がかかることがあります。契約中のプランで使えるかを、提供元の料金表か窓口で確かめます
- 呼べる回数に上限があるか。APIには、一定の時間に呼べる回数の上限が決まっているものがあります。件数が多い業務では、上限に当たると処理が止まったり待たされたりします。1日にどれくらいの件数を流したいかを先に伝えて、上限の中に収まるかを見ます
ここで確かめるべき内容は、サービスごとに公式の資料に書かれています。具体的な上限や料金は、使うサービスの公式の資料を開いて、その時点の内容を見るのが確実です。古い記事やSNSの情報は、そのままは信じないほうが安全です。
あわせて、もう1つ見ておきたいのが契約上、外からつなぐことが認められているかです。保守契約や利用規約で、外部のプログラムからの接続が制限されていることがあります。保守の範囲についてはシステム保守はどこまで?も参考になります。
API連携の費用は、何で決まりますか?
費用は、作る量と、あとの面倒を見る量で決まります。決まり方の要素は次のとおりです。
| 決まる要素 | 費用が上がる方向 | 理由 |
|---|---|---|
| つなぐ相手の数 | 相手が増える | 相手ごとにAPIの決まりが違い、確認と試験が増える |
| 読むだけか、書き込むか | 書き込みがある | 間違った内容を書くと元に戻す手間が出るため、確認の仕組みが要る |
| 流す件数と頻度 | 件数が多い・頻繁 | 回数の上限や、処理の速さを考える必要がある |
| 失敗したときの扱い | 自動でやり直す・通知する | 相手のシステムが止まっていたときにどうするかを決めて作る |
| 相手の変更への追従 | 提供元がAPIの仕様を変える | つないだあとも、仕様変更に合わせた手直しが続く |
| 認証・権限の整理 | 権限が細かい | 誰の権限でつなぐか、どの範囲を見せるかを決める必要がある |
費用の一般的な相場は、ここには書きません。同じ「API連携」でも、上の要素で金額が大きく変わるためです。当社の実例だけを書くと次のとおりです。
- 営業支援基盤の事例では、すでに使っていたCRMとAPIで双方向に同期し、入れ直しをせずに済むようにしました(実例の詳細)
- 食品メーカーの注文一覧の事例(月額5万円・税別・初期費用0円)では、物流側のシステムとつなぐAPIを稼働後に追加しています。追加は通常の修正として月額の中で対応しています(実例の詳細)。なお物流側との連携は、相手のシステムにAPIか取り込みの口があることが条件です
APIがない相手を画面操作の自動化でつないだ実例は、月額1万円〜4万円(税別)の範囲です(実例の詳細)。つなぐ相手の数と操作の複雑さで変わります。
この条件で、自社の場合を聞く → 仕様書は要りません。1営業日以内に、範囲と月額をお返しします。
APIがないときは、どうしますか?
APIがなくても、道は残ります。順番に試します。
- CSVの書き出しと取り込みがないか見る。書き出したCSVを加工して、取り込める形にして渡します
- CSVもなければ、画面操作の自動化(RPA)を使う。人が画面でやっている操作を、同じ順番で自動にします。システムは入れ替えません
当社の実例では、APIのない取引先の受発注サイトから、毎日の注文のCSVを落として販売管理に取り込むまでを自動にしています(月額3万円・税別・初期費用0円。実例の詳細)。会計ソフトへの登録でも、公式のAPIがあればAPIで、なければCSVの取り込みファイルを作るところまでを自動にし、それも無理な画面だけRPAで操作する、という順で考えています(2022年ごろの実例。現在は稼働していません)。
APIがあるのに画面操作の自動化で作ると、相手の画面が変わるたびに止まる仕組みを自分から選ぶことになります。APIがあるなら、APIのほうが確実です。
API連携の限界や、気をつける点は何ですか?
- 提供元が仕様を変えると、手直しが要ります。つないだあとも、変更の知らせを受け取って直す体制が前提です
- 相手のシステムが止まっていると、そのときは渡せません。止まったときにやり直すのか、通知して人が見るのかを、先に決めておきます
- API連携は、業務の流れ自体を直してくれるわけではありません。転記をなくすことはできますが、手順や例外の扱いが決まっていなければ、先にそこを整理します
- 相手の通知を待って動かしたい場合は、APIとは別の仕組み(Webhook)が向きます。違いはWebhookとは?APIとの違いと、業務での使いどころに書きました
開発会社に聞くことは何ですか?
見積もりの前に、次を聞くと、頼んだあとの食い違いを減らせます。
- つなぐ相手のAPIで、読むだけ・書き込みまでのどこまでをやる前提の見積もりか
- 相手のAPIの料金プランの条件と回数の上限を、いつの時点の公式資料で確かめたか
- 相手が仕様を変えたときの手直しは、月額に含まれるか、別料金か
- 失敗したときに、どう気づけるか(通知)、誰が直すか
- 相手のAPIがない場合の、CSVや画面操作の自動化という代わりの案はあるか
まとめ
- API連携とは、システムが用意した「外からつなぐ口」を使って、人を介さずにデータをやり取りさせること
- 頼む前に、APIの有無、今の料金プランで使えるか、呼べる回数の上限の3点を、公式の資料で確かめる
- 費用は、つなぐ相手の数、読むだけか書き込むか、失敗時の扱い、仕様変更への追従で決まる。APIがなければCSVかRPAが残る
当社の実例は、APIのない受発注サイトの注文を販売管理に取り込む事例と営業支援基盤とCRMのAPI連携の事例に詳しく書いています。初期費用0円・月額1万円〜(税別)で、稼働するまで課金はありません。今お使いのシステムの名前と、つなぎたい相手を教えてもらえれば、APIでつなげるのか、CSVや画面操作の自動化が残るのかをお答えします。お問い合わせからどうぞ。