kintoneのレコードをPythonから条件クエリー(チェックボックス)で取得する

2017/05/06

Google Calendar Twilio Reminderのkintoneのレコードを取得する部分の説明です。

kintoneアプリの作成

以下の項目を持つアプリを作成します。

フィールド名	フィールドコード	タイプ	内容
メールアドレ	calendar＿id	文字列(1行)	Googleアカウントのメールアドレス
電話番号	tel_number	文字列(1行)	Twilioからかかってくる先の電話番号
無効	invalid	チェックボックス	選択項目は「無効」のみ

※「無効」は設定を無効にするための項目です。レコード削除でも同じです。

コード説明

# coding:utf-8

import logging
import requests
import json
import os
import sys
import traceback

logger = logging.getLogger()
logger.setLevel(logging.INFO)

class KintoneCalendarCall(object):

    def __init__(self):
        KINTONE_URL = "https://{kintone_domain}/k/v1/records.json?app={kintone_app}"
        self.url = KINTONE_URL.format(
            kintone_domain=os.environ['KINTONE_DOMAIN'],
            kintone_app=os.environ['KINTONE_APP']
        )
        self.headers_key = os.environ['KINTONE_HEADERS_KEY']
        self.api_key = os.environ['KINTONE_API_KEY']
        self.basic_headers_key = os.environ['KINTONE_BASIC_HEADERS_KEY']
        self.basic_headers_value =os.environ['KINTONE_BASIC_HEADERS_VALUE']
        self.query = u'&query=invalid not in ("無効")'

    def get_regist(self):
        try:
            headers = {self.headers_key: self.api_key}
            if self.basic_headers_value != '':
                headers[self.basic_headers_key] = self.basic_headers_value
            response_record = requests.get(self.url + self.query , headers=headers)
            record_data = json.loads(response_record.text)
            logger.info(record_data)
            records = record_data['records']

            return records

        except Exception as e:
            logger.error(traceback.format_exc(sys.exc_info()[2]))

# coding:utf-8

import logging

import requests

import json

import os

import sys

import traceback

logger = logging.getLogger()

logger.setLevel(logging.INFO)

class KintoneCalendarCall(object):

def __init__(self):

KINTONE_URL = "https://{kintone_domain}/k/v1/records.json?app={kintone_app}"

self.url = KINTONE_URL.format(

kintone_domain=os.environ['KINTONE_DOMAIN'],

kintone_app=os.environ['KINTONE_APP']

)

self.headers_key = os.environ['KINTONE_HEADERS_KEY']

self.api_key = os.environ['KINTONE_API_KEY']

self.basic_headers_key = os.environ['KINTONE_BASIC_HEADERS_KEY']

self.basic_headers_value =os.environ['KINTONE_BASIC_HEADERS_VALUE']

self.query = u'&query=invalid not in ("無効")'

def get_regist(self):

try:

headers = {self.headers_key: self.api_key}

if self.basic_headers_value != '':

headers[self.basic_headers_key] = self.basic_headers_value

response_record = requests.get(self.url + self.query , headers=headers)

record_data = json.loads(response_record.text)

logger.info(record_data)

records = record_data['records']

return records

except Exception as e:

logger.error(traceback.format_exc(sys.exc_info()[2]))

変数取得

AWS Lambdaの環境変数設定を使っています。
kintone関係の環境変数は以下です。

変数名	設定値
KINTONE_DOMAIN	kintoneのドメイン xxx.cybozu.com
KINTONE_APP	kintoneのアプリの数字
KINTONE_HEADERS_KEY	X-Cybozu-API-Token
KINTONE_API_KEY	kintoneのAPIキー
KINTONE_BASIC_HEADERS_KEY	Authorization
KINTONE_BASIC_HEADERS_VALUE	kintoneベーシック認証のキー(Basic)で始まる

クエリーは固定で &query=invalid not in (“無効”) としています。
これでkintoneで「無効」のチェックが入っていないレコードのみを取得します。

KINTONE_DOMAIN

この xxx.cybozu.com を設定します。
契約によっては「cybozu.com」じゃない場合もあるようです。

KINTONE_APP

kintoneのアプリを開いたときのURLの数字を設定します。

KINTONE_HEADERS_KEY

固定で「X-Cybozu-API-Token」です。
万が一変更があったときのために変数化しています。

KINTONE_API_KEY

[アプリの設定を変更]をクリックします。

[カスタマイズ/サービス連携]の[APIトークン]をクリックします。

[生成する]をクリックしてAPIトークンを生成します。
権限は閲覧のみにします。

ここで生成されたAPIトークンをKINTONE_API_KEYに設定します。

KINTONE_BASIC_HEADERS_KEY

固定で「Authorization」です。
万が一変更があったときのために変数化しています。
アクセス制限をしてない環境では不要です。

KINTONE_BASIC_HEADERS_VALUE

「Basic 」とBasic認証に使用している「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。

例 : ログイン名が「Administrator」、パスワードが「cybozu」の場合
Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

アクセス制限をしてない環境では不要です。

レコード取得

headersにX-Cybozu-API-TokenとAPIトークンを設定
Basic認証をしている場合はheadersに設定
https://{kintone_domain}/k/v1/records.json?app={kintone_app}&query=invalid not in (“無効”) とheaders を引数にしてrequestsパッケージを使ってGETリクエストします。
レコード取得結果をデコーディングして[records]の値を戻します。

最後までお読みいただきましてありがとうございました！

「AWS認定資格試験テキスト＆問題集　AWS認定ソリューションアーキテクト - プロフェッショナル改訂第2版」という本を書きました。