ヘルプで見つからない情報は、サポートにお問い合わせください。お問い合わせ

開発者向け機能:API機能:組織操作:インポート

組織インポートAPIの機能仕様です。
APIを使用して組織情報をインポートします。

■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。

■リクエスト 
下記のリクエスト形式で、CSVデータとjsonデータを送信します。

<設定項目>

設定項目
HTTPメソッド POST
Content-Type multipart/form-data
文字コード UTF-8
URL https://ks01.shelterdb.net/api/depts/import
Body 下記「Bodyに指定する項目」を参照のこと

 

<Bodyに指定する項目>

項目名
parameters 下記「APIパラメータ」の内容をJSON形式の文字列で指定
file 登録するCSVファイルのバイナリデータ

 

<APIパラメータ>

項目名 設定例 備考
ApiVersion 1.1 APIバージョン
ApiKey "345yuAjA6789dA09d8uj6... 取得したAPIキー
Encoding Shift-JIS CSVファイルのエンコーディング。"UTF-8"または"Shift-JIS"を指定

 

■実行例のサンプル

PowerShell(version6.0 以降)のサンプル

$uri = 'http://servername/api/depts/import'
$filePath = "./sample.csv"
$form = @{
    parameters = ConvertTo-Json @{
        ApiVersion = 1.1;
        ApiKey = "4d84b4773a58bbc3c4...";
        Encoding = "UTF-8";
    };
    file = Get-Item -Path $filePath;
}
Invoke-WebRequest -Uri $uri -Method Post -Form $form


Pythonのサンプル

import requests
import json

url = "https://servername/api/depts/import"
filePath = "./sample.csv"
data = {
    "parameters": json.dumps({
        "ApiVersion" : 1.1,
        "ApiKey" : "4d84b4773a58bbc3c4...",
        "Encoding" : "UTF-8"
    })            
}
files = {
    "file":("sample.csv", open(filePath,"rb"), "text/csv")
}
response = requests.post(url, data, files=files)
print(response.content.decode())


■レスポンス
下記の形式のjsonデータが返却されます。

{
  "Id":0,
  "StatusCode":200,
  "Message":"50 件追加し、12 件更新しました。"
}
  • はじめてご利用になる方へ
Powered by Zendesk