星座占い指数API開発用ドキュメント
「星座占い指数API」のAPI仕様についてご紹介します。
API概要
「星座占い指数API」は占いコンテンツを提供するAPIです。
下記のようなURIにリクエストを送ることで、占いコンテンツがXML/JSONデータとして提供されます。
https://[サーバードメイン]/fortune_degree?userid=[ユーザID]
提供コンテンツ
各星座ごとに、下記のコンテンツを提供します。
- 総合運、勉強運、仕事運、金運、恋愛運、対人運、健康運 の幸運度指数
- ラッキーカラー
- 吉方(幸運な方角)
更新タイミング
随時未来日付の占いを先行して準備しています。
取得可能な占い対象年月日は、当日から2か月先までです。
リクエスト形式
URI形式
https://[サーバードメイン]/fortune_degree?userid=[ユーザID]&date=[指定日]&birth=[生年月日]&resulttype=[結果形式]
サーバードメイン
urarafortune.net （プライマリAPIサーバードメイン）
urarafortune2.net （セカンダリAPIサーバードメイン）
のいずれかを指定します。
ユーザID
ご契約時に発行されるユーザIDを指定します。
指定日
クエリ変数dateに指定日コードを指定することで、対象日を選択できます。指定形式はyyyymmddです。(例：20200401)
生年月日
クエリ変数birthに指定日コードを指定することで、対象日を選択できます。指定形式はyyyymmddまたはmmddです。(例：20200401、0401、401)
結果形式
クエリ変数resulttypeに結果形式を指定することで、結果の形式を選択できます。(XML形式またはJSON形式)
レスポンス形式
XML形式
<?xml version="1.0" encoding="UTF-8" ?>
<announce lastAnnounce="2020-07-29 13:03:11" fortuneDate="2020-04-29">
<degree code="0" name="牡羊座" datefrom="03-21" dateto="04-19">
<total>6</total>
<study>3</study>
<work>2</work>
<money>7</money>
<love>4</love>
<community>7</community>
<helth>5</helth>
<colorcd>255:0:0</colorcd>
<colorkana>レッド</colorkana>
<colorkanji>赤色</colorkanji>
<colorno>7</colorno>
<azimuth>西北西</azimuth>
<azimuthno>14</azimuthno>
</degree>
12星座分繰り返し
：
</announce>
JSON形式
{
"announce":{"lastAnnounce":"2020-07-29 13:04:11","fortuneDate":"2020-04-29",
"degree":[
{ "code":"0","name":"牡羊座","datefrom":"03-21","dateto":"04-19",
"total":"6",
"study":"3",
"work":"2",
"money":"7",
"love":"4",
"community":"7",
"helth":"5",
"colorcd":"255:0:0",
"colorkana":"レッド",
"colorkanji":"赤色",
"colorno":"7",
"azimuth":"西北西",
"azimuthno":"14"
},
：
12星座分繰り返し
：
]
}
}
各要素の説明
announce
ルート要素です。
| lastAnnounce | APIの処理日時 |
|---|---|
| fortuneDate | 占いの対象日 |
degree
各星座ごとの占い指数を格納する要素です。
| code | 00:牡羊座,01:牡牛座,02:双子座,03:蟹座,04:獅子座,05:乙女座,06:天秤座,07:蠍座,08:射手座,09:山羊座,10:水瓶座,11:魚座 |
|---|---|
| name | 星座名称 |
| datefrom | 星座の範囲月日の開始日 |
| dateto | 星座の範囲月日の終了日 |
total
総合運の幸運度を示す要素です。
| total | 総合運 1(幸運度低)～10(幸運度高) |
|---|
study
勉強運の幸運度を示す要素です。
| study | 勉強運 1(幸運度低)～10(幸運度高) |
|---|
work
仕事運の幸運度を示す要素です。
| work | 仕事運 1(幸運度低)～10(幸運度高) |
|---|
money
金運の幸運度を示す要素です。
| money | 金運 1(幸運度低)～10(幸運度高) |
|---|
love
恋愛運の幸運度を示す要素です。
| love | 恋愛運 1(幸運度低)～10(幸運度高) |
|---|
community
対人運の幸運度を示す要素です。
| community | 対人運 1(幸運度低)～10(幸運度高) |
|---|
helth
健康運の幸運度を示す要素です。
| helth | 健康運 1(幸運度低)～10(幸運度高) |
|---|
colorc、colorkana 、colorkanji、colorno
ラッキーカラーを示す要素です。12色の中から星座ごとにラッキーカラーを判定します。
| colorcd | ラッキーカラーのカラーコード R:G:B (それぞれ0~255) |
|---|---|
| colorkana | ラッキーカラーのカラー名(カナ) |
| colorkanji | ラッキーカラーのカラー名(漢字) |
| colorno |
ラッキーカラーの番号(下記参照) カラーコード,カラー名(カナ),カラー名(漢字),カラー番号 '32:32:196','ダークブルー','紺色',0 '0:96:255','ブルー','青色',1 '0:255:0','グリーン','緑色',2 '191:255:255','スカイブルー','空色',3 '200:200:255','ヴァイオレット','菫色',4 '200:0:255','パープル','紫色',5 '200:255:0','ライトグリーン','黄緑色',6 '255:0:0','レッド','赤色',7 '128:32:32','ブラウン','茶色',8 '255:120:240','ピンク','桃色',9 '255:200:0','オレンジ','橙色',10 '255:255:0','イエロー','黄色',11 |
azimuth、azimuthno
吉方を示す要素です。
| azimuth | 吉方(幸運な方角)な16方位 |
|---|---|
| azimuthno |
吉方番号(下記参照) 吉方番号,吉方
1,'北'
2,'北北東' 3,'北東' 4,'東北東' 5,'東' 6,'東南東' 7,'南東' 8,'南南東'
9,'南'
10,'南南西' 11,'南西' 12,'西南西' 13,'西' 14,'西北西' 15,'北西' 16,'北北西' |
