Kintone Workshop REST API Commands

1_Kintone_Workshop_REST_API_Commands.md

Kintone x Intro to REST API Workshop

Thank you for attending our event!

Download Links:

• Just only the slides.pdf
• Both the code and slides

Sign-up for a Kintone Developer Program (KDP) Account:

• https://developer.kintone.io/hc/en-us/signup
• ⚡ Be sure to Accept Cookies before filling out the sign-up form!

Sign-up for a Developer License:

• Developer License Application Form

Open a Code Editor

• We recommend Visual Studio Code

Check how to start up your...

• Terminal for Macs users
• PowerShell for Windows users

Mac_A_Symbols_in_cURL.md

Symbols in cURL

Example cURL GET API Call:

curl -X GET 'https://devevents.kintone.com/k/v1/record.json' \
      -H 'X-Cybozu-API-Token: _Token_Here_' \
      -H 'Content-Type: application/json' \
      -d '{"app": 1, "id": 1}'

Breakdown of the Symbols

Symbol	Meaning
curl	command-line tool for transferring data
-X	short for --request; used to set request method & endpoint
-H	short for --header; used to set the header option
-d	short for --data; used to set the body component
\	add a space & backslash to make a multi-line command

Mac_B_GET_Example.txt

# In a single-line format:
curl -X GET 'https://devevents.kintone.com/k/v1/record.json' -H 'X-Cybozu-API-Token: E4MYYOKtoa1IjRpt0sSJeBscjd6oXPV6ueIZ2qFV' -H 'Content-Type: application/json' -d '{"app": 1, "id": 1}'

# In multi-line format:
curl -X GET 'https://devevents.kintone.com/k/v1/record.json'\
  -H 'X-Cybozu-API-Token: E4MYYOKtoa1IjRpt0sSJeBscjd6oXPV6ueIZ2qFV'\
  -H 'Content-Type: application/json'\
  -d '{"app": 1, "id": 1}'

Mac_C_GET_Template.txt

# Be sure to Insert your Subdomain, Token, App ID, and Record ID!

# In a single-line format:
curl -X GET 'https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json' -H 'X-Cybozu-API-Token: INSERT_TOKEN' -H 'Content-Type: application/json' -d '{"app": INSERT_APPID, "id": INSERT_RECORDID}'

# In multi-line format:
curl -X GET 'https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json'\
  -H 'X-Cybozu-API-Token: INSERT_TOKEN'\
  -H 'Content-Type: application/json'\
  -d '{"app": INSERT_APPID, "id": INSERT_RECORDID}'

Mac_D_POST_Template.txt

# Mac Terminal POST Template
# Be sure to Insert your Subdomain, Token, App ID, and Data!

# In a single-line format:
curl -X POST 'https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json' -H 'X-Cybozu-API-Token: INSERT_TOKEN' -H 'Content-Type: application/json' -d '{"app": INSERT_APPID, "record": {"name": {"value": "John Snow"}, "show": {"value": "Game of Thrones!"}}}'

# In multi-line format:
curl -X POST 'https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json' \
  -H 'X-Cybozu-API-Token: INSERT_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"app": INSERT_APPID, "record": {"name": {"value": "John Snow"}, "show": {"value": "Game of Thrones!"}}}'

Mac_E_Github_Zen_curl.txt

curl -X GET 'https://api.github.com/zen'

Mac_F_Github_User_curl.txt

# Remember to insert your Github username & Personal Access Token

# Public
curl -X GET 'https://api.github.com/users/<USERNAME>'

# Private
curl -X GET 'https://api.github.com/users/<USERNAME>' -H 'Authorization: Token <INSERT_TOKEN>'

Windows_A_Symbols_in_Invoke-WebRequest.md

Symbols in PowerShell's Invoke-WebRequest

Example Invoke-WebRequest GET API Call

Invoke-WebRequest -Headers @{'X-Cybozu-API-Token' = 'E4MYYOKtoa1IjRpt0sSJeBscjd6oXPV6ueIZ2qFV'} `
  -Method GET `
  -Uri https://devevents.kintone.com/k/v1/record.json `
  -Body @{'app' = '1'; 'id'= '1'} `
  -OutFile GET_API_Output.txt

Breakdown of the Symbols

Symbol	Meaning
Invoke-WebRequest	cmdlets tool for transferring data
-Headers	setting the header option
-Method	setting the request method
-Uri	setting the Endpoint component
-Body	setting the body component
`	add a space & grave accent for multi-line commands
@{…}	saves the information as a hash table
-OutFile XYZ	saves the output of the PowerShell command into the file named 'XYZ'

Windows_B_GET_Example.txt

# The full JSON output is stored in the newly generated GET_API_Output.txt file

# In a single-line format:
Invoke-WebRequest -Headers @{'X-Cybozu-API-Token' = 'E4MYYOKtoa1IjRpt0sSJeBscjd6oXPV6ueIZ2qFV'} -Method GET -Uri https://devevents.kintone.com/k/v1/record.json -Body @{'app' = '1'; 'id'= '1'} -OutFile GET_API_Output.txt

# In multi-line format:
Invoke-WebRequest -Headers @{'X-Cybozu-API-Token' = 'E4MYYOKtoa1IjRpt0sSJeBscjd6oXPV6ueIZ2qFV'} `
  -Method GET `
  -Uri https://devevents.kintone.com/k/v1/record.json `
  -Body @{'app' = '1'; 'id'= '1'} `
  -OutFile GET_API_Output.txt

Windows_C_PowerShell_Debug.txt

# Check the TLS version used:
[Net.ServicePointManager]::SecurityProtocol

# Set TLS 1.2 with the following command:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Windows_D_GET_Template.txt

# Be sure to Insert your Subdomain, Token, App ID, and Record ID!

# In a single-line format:
Invoke-WebRequest -Headers @{'X-Cybozu-API-Token' = 'INSERT_TOKEN'} -Method GET -Uri https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json -Body @{'app' = 'INSERT_APPID'; 'id'= 'INSERT_RECORDID'} -OutFile GET_API_Output.txt


# In multi-line format:
Invoke-WebRequest -Headers @{'X-Cybozu-API-Token' = 'INSERT_TOKEN'} `
  -Method GET `
  -Uri https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json `
  -Body @{'app' = 'INSERT_APPID'; 'id'= 'INSERT_RECORDID'} `
  -OutFile GET_API_Output.txt

Windows_E_POST_Template.txt

# Windows PowerShell POST Template
# Be sure to Insert your Subdomain, Token, App ID, and Data!

# In a single-line format:
Invoke-WebRequest –Headers @{'X-Cybozu-API-Token' = 'INSERT_TOKEN' ; 'Content-Type' = 'application/json'} –Method POST –Uri https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json –Body '{"app": INSERT_APPID, "record": {"name": {"value": "John Snow"}, "show": {"value": "Game of Thrones!"}}}'

# In multi-line format:
Invoke-WebRequest `
  –Headers @{'X-Cybozu-API-Token' = 'INSERT_TOKEN' ; 'Content-Type' = 'application/json'} `
  –Method POST –Uri https://INSERT_SUBDOMAIN.kintone.com/k/v1/record.json `
  –Body '{"app": INSERT_APPID, "record": {"name": {"value": "John Snow"}, "show": {"value": "Game of Thrones!"}}}'

Windows_F_Github_Zen_PowerShell.txt

Invoke-WebRequest -Method GET -Uri https://api.github.com/zen

Windows_H_Github_User_PowerShell.txt

# Remember to insert your Github username & Personal Access Token

# Public
Invoke-WebRequest -Method GET -Uri https://api.github.com/users/<USERNAME>

# Private
Invoke-WebRequest -Headers @{'Authorization' = 'Token <PERSONAL ACCESS TOKEN>'} -Method GET -Uri https://api.github.com/users/<USERNAME>

z_Slides.pdf