企業評価なら「会社番付」│トップ >会社番付API > 会社番付API利用マニュアル

会社番付API利用マニュアル

●APIの呼出しについて
APIの基本的なフローは下記のようになります。
①指定されたURLに必要なパラメータを付加し、GET形式でHTTPリクエストを送信します。
②XML形式のレスポンスが取得されるので、パースしてデータを取得します。

●会社番付API呼び出しメソッドのURLについて
メソッドの呼出しURLは下記の構成となります。
https://rest.company-score.com/rest/api/execCorporationSearchRMDB + クエリパラメータ(GET) ※クエリパラメータは以下項目をご確認ください。

●URL作成例
RMDB企業検索を検索文字列=ソニー、都道府県=東京都(13)で検索する場合、下記のようなURLとなります。
https://rest.company-score.com/rest/api/execCorporationSearchRMDB?memberCode=012345678912345&password=xxxxxxxx&searchTerm= %E3%82%BD%E3%83%8B%E3%83%BC=&locationCode=13 ※searchTermのパラメータ(%E3%82…)は「ソニー」をUTF-8でURLエンコードした値です。

●応答データ
呼出し用URLにアクセスするとXML形式のレスポンスが返されます。 XMLをパースすることで、データの取得ができます。
                <?xml version="1.0" encoding="UTF-8"?>
                <rmCorporationSearchResult>
                  <count>2</count>
                  <rmCorporation>
                   <jisAddressCode>11111</jisAddressCode>
                   <location>東京都港区</location>
                   <postalCode>141-0001</postalCode>
                   <rmCode>123456789</rmCode>
                   <telNumber>03-1111-1111</telNumber>
                   <tradename>(株)あいうえお</tradename>
                  </rmCorporation>
                  <rmCorporation>
                   <jisAddressCode>22222</jisAddressCode>
                   <location>東京都中央区</location>
                   <postalCode>141-0001</postalCode>
                   <rmCode>123456789</rmCode>
                   <telNumber>03-1111-1111</telNumber>
                   <tradename>かきくけこ(株)</tradename>
                  </rmCorporation>
                  <status>0000000</status>
                </rmCorporationSearchResult>
                

●サンプルIDについて
開発検証用途に上場企業に限定したURL、会員ID、PWを用意しております。
正式IDが発行前にご利用頂くことが可能です。

URL:
サンプル用)
https://rest.company-score.com/rest/api/execCorporationSearchRMDBTrial + クエリパラメータ(GET)

クエリパラメータ
・項番1会員ID「998888001200005」
・項番2パスワード「zzzzz123」



●仕様詳細について

クエリパラメータ
項番 キー 名称 サイズ 固定長 備考
1 memberCode 会員ID 半角15文字 固定長 会社番付から発行されたID。半角数字、省略不可
2 password パスワード 半角8~16文字 可変長 会社番付から発行されたPW。半角英数字、省略不可
3 searchTerm 検索文字列 全角10文字 可変長 1文字以上の検索用ワード、省略不可
※要URLエンコード
4 locationCode 地域コード 半角2文字 可変長 都道府県コード01~47(下記参照)、省略可

応答データ
項番 タグ名 名称 サイズ 固定長 備考
1 rmCorporationSearchResult 企業検索結果 エラーの場合はステータスのみを返す
企業検索結果を格納
詳細は下記一覧表参照

企業検索結果の仕様
項番 タグ名 名称 サイズ 固定長 備考
1 status ステータス 半角7文字 固定長 0000000で正常終了
2 count 検索件数 半角2文字 可変長 検索件数0~50
3 rmCorporation 項番3-1~3-6のまとめ要素
3 1 rmCode RMコード 半角9文字 固定長 企業検索結果のRMコード
3 2 tradename 商号 全角100文字 可変長 企業検索結果の法人格を含む商号
オーバーしている部分は省略
データが NULL の場合「-」(全角ハイフン)を返す
3 3 jisAddressCode JIS住所コード 半角5文字 固定長 JIS住所コード
5桁の半角数字、コード不明の場合は 00000
3 4 location 所在地 全角140文字 可変長 企業検索結果の本社所在地
データが NULL の場合「-」(全角ハイフン)を返す
3 5 postalCode 郵便番号 半角8文字 固定長 企業検索結果の郵便番号
データが NULL の場合、空文字列を返す
3 6 telNumber 電話番号 半角17文字 可変長 企業検索結果の電話番号
データが NULL の場合、空文字列を返す
※上記項番3(3-1~3-6含む)は、正常終了以外または検索件数0件の場合
 はリスト内に当該要素は存在しない。

検索文字の指定について
No 説明
1 ・商号を全角文字で指定する。(半角文字については全角変換を試みる。但し記号等、変換対象外あり。)※1
2 ・商号の法人格(株式会社、(株)など)、ドット「・」は省く。
3 ・全角1文字以上、10字以下で指定する。※2
4 ・部分一致で検索が行われる。
5 ・検索結果は、完全一致、前方一致(商号の短いものを優先)、部分一致(商号の短いものを優先)の順に最大50件を返す。
(上記同条件の場合はRMコード順)
※1  ・・・ 全角変換後に半角文字が含まれていた場合はエラーとする。
※2  ・・・ 空文字はエラー。
        11文字以上だった場合は前10文字までで切った文字列で検索を
        行う。(エラーとしない)
企業検索結果のステータス
No ステータス 説明
1 0000000 正常終了
2 0000201 不正な会員コード・パスワード。
3 0370101 会員コードがnull、桁数不正(15桁以外)、
文字種不正(半角英数以外の文字が含まれている)
4 0370102 パスワードがnull、桁数不正(8-16桁以外)、
文字種不正(半角英数以外の文字が含まれている)
5 0370103 検索文字列がnull、文字種不正(全角文字以外が含まれる)
6 0370104 47都道府県コード以外を指定
7 0370301 処理状況エラー(RMDBメンテナンス中)

地域コード
コード 都道府県名
01 北海道
02 青森
03 岩手
04 宮城
05 秋田
06 山形
07 福島
08 茨城
09 栃木
10 群馬
11 埼玉
12 千葉
13 東京
14 神奈川
15 新潟
16 富山
コード 都道府県名
17 石川
18 福井
19 山梨
20 長野
21 岐阜
22 静岡
23 愛知
24 三重
25 滋賀
26 京都
27 大阪
28 兵庫
29 奈良
30 和歌山
31 鳥取
32 島根
コード 都道府県名
33 岡山
34 広島
35 山口
36 徳島
37 香川
38 愛媛
39 高知
40 福岡
41 佐賀
42 長崎
43 熊本
44 大分
45 宮崎
46 鹿児島
47 沖縄