先日、個人で新サービスを立ち上げました。
組織間でデータを送受信でき、受け取ったデータをノーコードでAPI公開できるサービスです。
自分あてにデータを送れば、自分用にAPIサーバーを立ち上げることもできます。
制限はありますが無料で始められます！
こちらを使って、ためしにノーコードでAPI公開してみたいと思います。
まずは登録
ユーザー登録
「パケットベース」への登録は簡単です。
名前とメールアドレス、好きなログインIDとパスワードを送信すると、メールアドレスが正しいか確認メールが飛びます。
メールに記載されたコードを入力すれば、登録完了です。
メールアドレスを使わず任意のログインIDを使うことで、認証情報を推測しづらくしています。
アドレスの登録
「パケットベース」では、一つのログインIDでいくつもアドレスを作ることができます。アドレスを使い分けて、取引相手を切り替えられます。
まずは右上の アドレスを作成 ボタンをクリックして最初のアドレスを登録します。
アドレスはメールアドレスと同じ扱いになるため、使いまわされるとデータの誤送信の原因となります。そのため一度作ったアドレスは変更できず、削除しても使いまわせません。
アドレスが登録できると、データ(パケットと呼んでいます)を送受信する準備が整います。
API公開の準備
バスケットの登録
データ(パケット)をAPI公開するには、バスケットと呼ばれるいわゆるメールボックスを登録する必要があります。
取引相手に合わせて、またAPI公開する内容に合わせて、バスケットを使い分けることができます。
登録する際は バスケットを追加 ボタンをクリックして登録を進めます。
フィルターの作成
フィルターの機能を使うと、データ(パケット)を受け取ったときに、自動的にバスケットに割り振ることができます。
送信元や、データ構造を見て振り分けできるので、内容によって公開する・しないを切り分けたりできます。
フィルターを追加する際は フィルター追加 ボタンをクリックすると追加できます。
パケットの登録
では、API公開するデータ(パケット)を用意してみます。
パケットを登録するには、アドレス画面の 新規パケット ボタンをクリックします。
パケットを自分のバスケットに入れるには、送信先アドレスを自分のアドレスに設定します。
データはJSONで用意します。今回はサンプルデータを使いました。
[
{
"id": 1,
"mail": "admin@example.com",
"memo": "管理者アカウント"
},
{
"id": 2,
"mail": "yamada@example.com",
"memo": "山田さんのアカウント"
},
{
"id": 3,
"mail": "sato@example.com",
"memo": "佐藤さんのアカウント"
},
{
"id": 4,
"mail": "tanaka@example.com",
"memo": "田中さんのアカウント"
},
{
"id": 5,
"mail": "watanabe@example.com",
"memo": "渡辺さんのアカウント"
}
]
パケットはJSONのオブジェクト一つにつき1パケットになって格納されます。
複数のオブジェクトの配列の場合は、一つ一つパケットに切り分けられて格納されます。そのため、大量のデータを一気に登録することもできます。
また、ファイルからの読み込みにも対応しています。
API公開
公開APIの登録
バスケットが追加できたら、そのバスケットをAPI公開してみます。
API公開を追加 をクリックして登録します。
API公開する際にAPIキーを設定したり、アクセス制限したいIPアドレスを設定したりすることができます。
公開APIも、誤送信の原因となるため使い回しできないようになっています。
これで準備が整いました。
APIサーバーを立ち上げるのにわざわざコードを書かなくても、ノーコードでデータのAPI公開ができるようになっています。
実際にアクセスしてみる
では、公開されたAPIに実際にアクセスしてみます。
今回は試しにPostmanを使ってアクセスしてみましょう。
公開APIのURLを入力して、メソッドはPOSTを選択、APIキーを設定したなら apiKey を設定します。
この状態で Send をクリックすれば、APIにアクセスできます。
このようにデータ取得ができました。
絞り込み、ソート、件数指定
公開APIは、絞り込みやソート、取得件数の指定をすることができます。
- 絞り込み：
queryパラメーターを指定します
単純なキーワード検索のほか、JSONPathでJSONデータを特定して値を指定することもできます
例：$.id==3 - ソート対象：
sortパラメーターを指定します
こちらはJSONオブジェクトの第一階層にあるデータで指定します
例：id - ソート順：
orderパラメーターを指定します
ascかdescを指定できます - 取得件数：
numberパラメーターを指定します
数値で指定します - ページ数：
pageパラメーターで指定します
number x page で表示開始箇所が特定されます
さいごに
いかがでしょうか？機能はシンプルですが、その分簡単にデータのやり取りやAPI公開ができるようになっています。
制限はありますが基本無料で使えるので、よかったら使ってみてくださいね！