2019年4月12日

開発者向け

                 

API の利用にあたって


Smallit-OCR APIは外部アプリケーションから利用できるプログラミングインタフェースです。

                 

アクセス権の考え方


API を利用する際のアクセス権限はリクエストの際に付与されている API Key によって決まります。 API Key はユーザごとに異なりますので、 API Key を使うことでそのユーザのアクセス権を引き継いでいるということになります。

                 

共通仕様


概要

API を利用する際の共通仕様は以下のとおりです。

項目説明
APIのバージョン1.0
使用するプロトコルHTTPS
文字コードUTF‒8
                 

リクエストヘッダ


API をリクエストする場合には、以下の共通リクエストヘッダが必要です。

ヘッダ説明
APIKEYユーザ毎に発行される API Key (32 桁の英数字)
                 

レスポンスヘッダ


API は RESTful API 設計に従って提供されており、標準の HTTP メソッドを使用します。

                 

ステータスコード一覧


API がエラーになった場合、以下の HTTP ステータスコードが返ってきます。下記以外のステータスコード(200 や 203 等)は HTTP の仕様に準じます。

コード  種別 説明
400 IMAGE_NOTATTACHED 画像が添付されていません
  IMAGE_FILENAMETOOLONG ファイル名が50文字を超えています
  IMAGE_TYPENOTSUPPORTED サポートされていない画像フォーマットです
401 APIKEY_NOTATTACHED APIキーが添付されていません
403 APIKEY_NOTEXIST APIキーが登録されていません
500 サーバエラー