API docs
  • OK SKY API Reference
  • Resources API
    • Resources object
      • Room object
      • Message object
      • MasterKeyword object
      • Client object
      • Member object
      • Memo object
      • Support object
      • Suggestion object
      • TrackerEntry object
      • UserEvent object
      • SupportDraftMessage object
      • User object
  • Webhook
    • Events
      • kind of messages event
      • kind of room event
      • kind of customer event
      • kind of user event
      • kind of support event
      • kind of message_event event
  • JavaScript SDK
    • widget
    • tracker
GitBook提供
このページ内
  • Resources API
  • Overview
  • GET Request Sample
  • Create Request Sample
  • Edit Request Sample
  • Delete Request Sample

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

Create Request Sample

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

Path Parameters

Name
Type
Description

string

Edit Request Sample

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

Path Parameters

Name
Type
Description

string

Delete Request Sample

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

Path Parameters

Name
Type
Description

string

次へResources API

最終更新 6 年前