OK SKY API Reference

Resources API

Overview

メッセージオブジェクトや、ユーザーオブジェクトなどのDB上に格納されている情報へのアクセスができるAPIです。

Dreaming in URL’s

https://{YOUR_OKSKY_DOMAIN}/rapi/v1/

YOUR_OKSKY_DOMAINは、テナント毎に発行されます。

Sample URLs

https://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/{resource_name}https://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/{resource_name}/{resource_id}https://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/{resource_name}/relationships/{resource_name}https://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/{resource_name}/relationships/{child_resource_name}/{child_resource_id}https://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/roomshttps://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/rooms/1/https://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/rooms/1/relationships/messageshttps://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/messageshttps://{YOUR_OKSKY_DOMAIN}.ok-sky.com/rapi/v1/messages/1

GET Request Sample

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/rooms

Query Parameters

Name	Type	Description
	string

Headers

Name	Type	Description
X-Access-Token	string	your access token set here.
Content-Type	string	application/vnd.api+json
Accept	string	application/vnd.api+json

200

Create Request Sample

POST https://{YOUR_OKSKY_DOMAIN}/rapi/v1/rooms

Path Parameters

Name	Type	Description
	string

200

Edit Request Sample

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/rooms/1

Path Parameters

Name	Type	Description
	string

200

Delete Request Sample

DELETE https://{YOUR_OKSKY_DOMAIN}/rapi/v1/rooms/1

Path Parameters

Name	Type	Description
	string

200