コラボフロー Advent Calendar 2022 4日目の記事です！
コラボフローってなんぞや？って方はこちらのページをご参照ください！
急に寒くなってきましたね・・・
暖房の効いた部屋で、暖かい鍋など食べながら、キンキンに冷えたペプシをキメたいなぁ
もしそれが、すき焼きだったら、もうこれはこれは・・・はい、ノンビンです!
さてさて、それでは記事書きますよー！
もう恋人との馴れ初めとかじゃないんだから、前置きなしで内容伝えるよ
今回のお題は
コラボフロー REST API
ジャイ！！！
みなさんコラボフロー REST APIってご存知です？
・・・ですよね？知ってると思ってました！！（あーよかった）
ご存知の方なら当たり前のように使うことができると思うのですが、
これから触り始めたい
エンジニアとして駆け出し
と言った方には、ちょっとハードルが高いですよね！
APIってどうやって叩くの？
ぽぽ・・・Postman？？cURL（カールと読みます）？？
わからな・・・・・・いいいいいいいい！！！
って方もいらっしゃるとは思うので、今回は簡単にコラボフローAPIを実行する方法を紹介します♪
リファレンスサイト
まずはこちらにアクセスしてみてください
こんな画面が出てきてるのでは無いでしょうか？
そうです・・・こちらが
コラボフロー REST APIのリファレンスサイト！！！
デス！！
そう、このサイトさえあれば勝ったようなものだ
まずは、下記画像の赤枠の部分を熟読すべし！！
ここに認証に関わる大切なことが記載されている！
次にServersのドロップダウンから、一番下の項目を選択する！
（クラウド環境用の認証セットになります）
ドロップダウンを選択したら、次にinstanceを設定する。
上記画像に記載されている「xxxxxxxx」については、自分のコラボフロー環境のURLから確認できます。
https://cloud.collaboflow.com/ の後ろに記載されている英数字が対象となります。
認証設定
ここまできたらあと一歩！！
最後の難関Authorize・・・なんて高い壁なんだ・・・
まずは下の画像の赤枠にある、ちょっとおしゃれな色をしたボタンをクリックだ！！
なんかセンチメンタルな背景をしたポップアップが表示されたぞ・・・
そう、ここのValueに入れる値こそ、最大最強の難関・・・秦の国門・函谷関レベルで突破が難しい。
たくさんの準備が必要だ・・・攻城戦は勢いだけじゃ突破できん！戦略も戦術も必要だ！！
まずは一個メモってくれ、さっきも熟読させた認証部分にヒントがあった
そう、この赤枠の部分だ
ごちゃごちゃ言うと面倒だと思うからこれをメモしてくれ
Basic LLLLL/apikey:AAAAAA
この文字列を使った手順はこのあと４つある
この文字列大切に取っておくんだ！大事なことだから２回言うぞ？
この文字列大切に取っておくんだ！
まずは「LLLLL」の部分を埋めよう
この「LLLLL」の部分とは何者か？というと・・・そうログインIDなのだ
コラボフローにログインするためのIDをここにセットする必要がある！
なぜか？それは、情報の取得するにも、承認や差し戻しするにも、「誰」がと言うのが必要になるからさ！
稟議書で、「誰かわからないけど、勝手に承認されてた！！わーーーーい♪♪」なんて人はいないはずだ・・・（いたら小一時間ほどお話ししよう）
そう、コラボフローはAPIで誰がどんな操作をしたか？と言うこともしっかり管理しているんだ！！安心だね！
みなさんは試す時に「LLLLL」にまずログインIDを設定してみてほしい
僕は今回わかりやすいように、「nonbin」と設定させてもらう！これが函谷関を突破する将軍の名前だ！
Basic LLLLL/apikey:AAAAAA
↓
Basic nonbin/apikey:AAAAAA
まずはこのような形になる！
次に「AAAAAA」の部分を埋めよう
この「AAAAAA」とは何かというと、そうシステムが発行してくれた万能鍵、その名も
APIキィィィィー！！！！
（叫んでみたけどなんか思ったほど気持ち良くなかった)
この万能鍵はどこでゲットできるかというと、コラボフローにシステム管理者権限のユーザーでログインしたあとに
右上の歯車をクリックする！！
出てきたではないか・・・システム管理エリアの扉！
見つけたらそこをクリックだ！！
下記のようなシステム管理エリアの画面が出てきたら、上に複数あるタブから、「環境設定」をクリックする！
色々な設定があるが、今回は一番下にある、「REST API」と言う設定を確認だ！！
ここを見つけたら、クライアント名に「API練習用」と入力して「APIキーを発行する」ボタンをクリックする！
（ここに表示されているAPIキーは既に削除済みなのでご安心ください）
こんな感じで使いされたことを確認したら、この「APIキー」の文字列をメモしておく！！
これも大事だから２度いうぞ！「APIキー」の文字列をメモしておく！！
そしたら、メモしたAPIキーを「AAAAAA」の部分に上書きする！！
Basic nonbin/apikey:AAAAAA
↓
Basic nonbin/apikey:FQGQZWxV35TQyrVeUqEruw6brJkWdXQy
うぉぉ!なんかそれっぽくなってきた！！
さてさてここまできたら、あとはラストスパートだ
魔法の言葉を伝えるぞ？準備はいいか？
base64エンコード
さてさて、魔法の言葉覚えてくれたかな？
詳しくはここらへん見るといいかも！
簡単に説明すると、API投げるためにbase64でエンコードする必要がある！！！
base64エンコード
これはいくつか方法がある！！
- webサイトでエンコードする
- プログラムを組む
- コンソール(macの場合)でコマンドを実行する
今回は「コンソール(macの場合)でコマンドを実行する」を試してみます！！
まずはコマンド文字列はこちら
echo -n 'beforeString' | base64
beforeStringの部分を今回変更したい文字列にします！！
今回はこんな感じ！！
Basic nonbin/apikey:FQGQZWxV35TQyrVeUqEruw6brJkWdXQy
「Basic 」の後にあるログインIDから後ろの文字列が対象となる
echo -n 'nonbin/apikey:FQGQZWxV35TQyrVeUqEruw6brJkWdXQy' | base64
実際にコマンドを実行するとこんな感じになる
赤枠の部分がエンコーディングされた文字列となるので、これで長かった準備が全て終わる！！
この文字列をメモするんだ！！！もう２度言わないぞ！！
Basic nonbin/apikey:FQGQZWxV35TQyrVeUqEruw6brJkWdXQy
↓
Basic bm9uYmluL2FwaWtleTpGUUdRWld4VjM1VFF5clZlVXFFcnV3NmJySmtXZFhReQ==
接続文字列できたーーーーーーー！！！よっしゃーーーー！！！
それではさっきの、センチメンタルな背景をしたポップアップを開いてValueの部分にこの文字列をぶち込むんだ！！！
もうこのあとは、使いたいAPIを選択して、実行するだけの簡単なお仕事だ
例えば、「Document (申請書に関する操作)」の検索APIを利用したいのであれば、
下記画像の赤枠をクリックして
次に「Try it out」をクリックする
APIに必要なパラメータを入力したら、最後に「Execute」をクリックしたら、攻城戦終了だ。
完全に君の勝ちは揺るがないだろう。
ただ、まだまだコラボフローには色々なカスタマイズの可能性が満ち溢れている！！
ぜひ、他の記事(コラボフロー Advent Calendar 2022)も参照して、新たなる戦へいざ進んでほしい！
さてさて、これで終わりにするが、ノンビンから一個だけ伝えさせてくれ
ノリで始めた口調が途中から辛すぎる！！！もう次はやらん！！
はい、ではノンビンでしたーーーまた会いましょう！