RAML

關於RAML

ChatWork API 是依據 RAML (RESTful API Modeling Language) 的格式進行api設計的管理。

程式介面和本 API 使用導引網站作為 API GATEWAY，以一個 RAML文件為基礎自動產生，並且可以同步更新資訊。

由於 RAML是以設計 RESTful API 為前提建立於YAML的基準並整合而成的格式，也因此在API 程式設計上可以簡單的操作讀取，並且適用各種對應RAML格式的工具。(RAML相關project)

例：RAML API Designer

ChatWork 表示法

關於表示法

在 ChatWork 內有一套專屬在訊息、工作及描述欄位內使用的表示法。

您可以運用這套表示法讓資訊更容易閱覽，也能夠活用 To 或是回覆等等功能。

ChatWork 的表示法使用 [ ]方括號來標記、就如同 HTML 語法使用< >來做標記一般。

其標示法分為這種單獨標記的方式[tagname:value]或[tagname attr=value]以及[tagname]...[/tagname]這樣的包圍在起始標記及終止標記方式。

在以下表示法說明中，使用{ }符號標記例如{account_id}或{room_id}這種標記方式可以用來表示帳號ID或是 room ID 等等資料。而...則用來表示任意文字。

ChatWork API 的 Endpoints 項目

Endpoint:/me

           可以查看自己的個人資訊

• GET/me查看個人情報

GET/me

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/me"

Response   

可以查看自己的個人情報

Endpoints (資料傳輸接點)

關於Endpoints 

ChatWork API 是根據 REST 原則架構而成的一套設計。
在 REST 原則裡，交談、工作等等的 resource 個別有一個對應的 URL 網址（即 endpoints ），您可以運用 GET、POST、PUT、DELETE 等等 HTTP Method 傳遞參數以進行發文或是刪除的操作。

Endpoints 的基本URL為 https://api.chatwork.com/v1
請於基本URL後面加上各 Endpoints 對應的路徑(path)。
（例：若路徑為 /me 其對應URL即 https://api.chatwork.com/v1/me ）

系統版本更新時，/v1 部分將會變更，並保留舊版本一段緩衝時間。

ChatWork API 的使用導引

歡迎來到 

ChatWork API 使用導引

本頁面為「ChatWork」專門提供給開發人員使用的 API 服務之詳細使用說明

與其他網路服務的連結方法～ChatWork與Zapier合作 之ー③

首先，謝謝大家對ChatWork的支持。

本篇，將對上篇中所提到7款常用網路服務，以外的網站連結方法加以說明。

輕鬆連結！７款網路服務連結設定方法教學！～ChatWork與Zapier合作 之ー②

首先，謝謝大家對ChatWork的支持。

本篇，是為了讓用戶們可以輕鬆、馬上連結使用，所製成的7種常用網路服務的連結設定方法說明。

Zapier的功能及初期設定方法∼ChatWork與Zapier合作 之ー①

首先，謝謝大家對ChatWork的支持。

這次，透過與Zapier的連結，「不論是誰」都可以「輕鬆的」將ChatWork與其他網路服務(Google Apps或Twitter、Dropbox、Github等等)做連結！