app

Anshin App API

Anshin App API は、anshin-backend の S2S scoped OpenAPI artifact から同期した server to server endpoint reference です。credential 管理と integration API を同じ構成で確認できます。

Scope groups

12 件

API items

73 件

Base URL

https://api.anshin.care

API artifact coverage

operations

65

write APIs

43

idempotency

91%

high risk

9

Data classification

confidential: 24
internal: 33
restricted: 8

Scope risk

high: 5
low: 17
medium: 35
none: 8

スコープ別 API

業務スコープを選ぶと、right side contents に API 項目一覧を表示します。

スコープAPI 項目

法人11 API items11 件事業所10 API items10 件事業所サービス10 API items10 件ご利用者12 API items12 件職員12 API items12 件ご利用者アセスメント1 API items1 件ご利用者サービス計画書1 API items1 件予定・実績1 API items1 件プロジェクト10 API items10 件プラン1 API items1 件投稿1 API items1 件連携運用3 API items3 件

表示：12 件

PUT /integrations/v1/companies/{company_id}/branches/by-external-id/{external_id}

Upsert by external ID 事業所

公開中

分類: guide
scope: app
API group: upsert_branch_by_external_id_for_integration
endpoint: PUT /integrations/v1/companies/{company_id}/branches/by-external-id/{external_id}

PUT/integrations/v1/companies/{company_id}/branches/by-external-id/{external_id}

対象を更新します

Auth

Integration token

Idempotency-Key

required

Scopes

1 required

operationId

upsert_branch_by_external_id_for_integration

Lifecycle

stable

Risk

medium

Classification

internal

Resource

branch

Required Scope

required

branches:write

Parameters

name	in	required	schema
company_id	path	required	integer
external_id	path	required	string
Idempotency-Key	header	required	string

Request

status	media type	schema
-	application/json	IntegrationBranchUpsertRequest namestringrequired nameKanastring \| nulloptional birthdaystring \| nulloptional notesstring \| nulloptional avatarinteger \| nulloptional mainOfficeinteger \| nulloptional satelliteOfficeinteger \| nulloptional areaClassinteger \| nulloptional publicOpeninteger \| nulloptional mycarTkjkstring \| nulloptional placeTkjkstring \| nulloptional smokingTkjkstring \| nulloptional certificateboolean \| nulloptional certificateDatestring \| nulloptional startTimestring \| nulloptional endTimestring \| nulloptional kasaninteger \| nulloptional addressarray \| nulloptional address.zipstring \| nulloptional郵便番号ハイフン無し/ address.address1string \| nulloptional住所 address.address2string \| nulloptional住所 address.address3string \| nulloptional住所 emailsarrayrequired emails.emailstringrequiredメールアドレス emails.labelstring \| nullrequiredケアマネメーリングリスト emails.certificateboolean \| nullrequired emails.certificate_datestring \| nullrequired phoneNumbersarray \| nulloptional phoneNumbers.phone_numberstringrequired番号 (識別子) phoneNumbers.labelstring \| nullrequired事業所代表番号 phoneNumbers.certificateboolean \| nullrequired phoneNumbers.certificate_datestring \| nullrequired example { "name": "サンプル", "nameKana": "サンプル", "birthday": "2026-07-21", "notes": "string", "avatar": 123, "mainOffice": 0, "satelliteOffice": 0, "areaClass": 0, "publicOpen": 1, "mycarTkjk": "string", "placeTkjk": "string", "smokingTkjk": "string", "certificate": true, "certificateDate": "string", "startTime": "string", "endTime": "string", "kasan": 0, "address": [ { "zip": "string", "address1": "string", "address2": "string", "address3": "string" } ], "emails": [ { "email": "user@example.com", "label": "例1", "certificate": true, "certificate_date": "string" } ], "phoneNumbers": [ { "phone_number": "03-0000-0000", "label": "string", "certificate": "string", "certificate_date": "string" } ] }

Response

status	media type	schema
200	application/json	SuccessResponse_IntegrationBranchDetail_ successbooleanrequired成功フラグ (True=成功) dataIntegrationBranchDetail \| nullrequiredレスポンス本体データ data.idintegerrequired data.companyIdintegerrequired data.externalIdstring \| nulloptional data.namestringrequired data.nameKanastring \| nulloptional data.birthdaystring \| nulloptional data.avatarinteger \| nulloptional data.mainOfficeinteger \| nulloptional data.satelliteOfficeinteger \| nulloptional data.areaClassinteger \| nulloptional data.publicOpeninteger \| nulloptional data.certificateboolean \| nulloptional data.certificateDatestring \| nulloptional data.startTimestring \| nulloptional data.endTimestring \| nulloptional data.kasaninteger \| nulloptional data.branchServiceIdsarrayoptional data.createdstring \| nulloptional data.updatedstring \| nulloptional data.deletedstring \| nulloptional request_idstring \| nullrequired関連リクエストID (オプトイン有効時のみ) metaPaginationMeta \| nullrequiredページネーション情報 meta.limitintegerrequiredMaximum number of items requested meta.offsetintegerrequiredNumber of items skipped from the start meta.totalintegerrequiredTotal number of items matching the query

Operation Contract

write operation	yes
bulk mode	-
bulk max items	-
bulk dry run	-
sync type	-
sync max limit	-
reconciliation	-

cURL

curl -X PUT "https://api.anshin.care/api/integrations/v1/companies/{company_id}/branches/by-external-id/{external_id}" \
  -H "Authorization: Bearer $ANSHIN_INTEGRATION_ACCESS_TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "サンプル",
  "nameKana": "サンプル",
  "birthday": "2026-07-21",
  "notes": "string",
  "avatar": 123,
  "mainOffice": 0,
  "satelliteOffice": 0,
  "areaClass": 0,
  "publicOpen": 1,
  "mycarTkjk": "string",
  "placeTkjk": "string",
  "smokingTkjk": "string",
  "certificate": true,
  "certificateDate": "string",
  "startTime": "string",
  "endTime": "string",
  "kasan": 0,
  "address": [
    {
      "zip": "string",
      "address1": "string",
      "address2": "string",
      "address3": "string"
    }
  ],
  "emails": [
    {
      "email": "user@example.com",
      "label": "例1",
      "certificate": true,
      "certificate_date": "string"
    }
  ],
  "phoneNumbers": [
    {
      "phone_number": "03-0000-0000",
      "label": "string",
      "certificate": "string",
      "certificate_date": "string"
    }
  ]
}'

Endpoint

field	value
method	PUT
path	/api/integrations/v1/companies/{company_id}/branches/by-external-id/{external_id}
operationId	upsert_branch_by_external_id_for_integration
auth	server to server integration client token
Idempotency-Key	required
lifecycle	stable
resource type	branch
data classification	internal
scope risk	medium
write operation	yes

Summary

対象を更新します

Required scope

scope	requirement
branches:write	required

Operation contract

field	value
bulk mode	-
bulk max items	-
bulk dry run	-
sync type	-
sync max limit	-
reconciliation	-

Path parameters

name	required	schema
company_id	required	integer
external_id	required	string

Query parameters

name	required	schema
-	-	-
-	-	-

Header parameters

name	required	schema
Idempotency-Key	required	string

Request body

status	media type	schema
-	application/json	IntegrationBranchUpsertRequest

Response

status	media type	schema
200	application/json	SuccessResponse_IntegrationBranchDetail_

Example

curl -X PUT "https://api.anshin.care/api/integrations/v1/companies/{company_id}/branches/by-external-id/{external_id}" \
  -H "Authorization: Bearer $ANSHIN_INTEGRATION_ACCESS_TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"example":"replace with request schema"}'

業務境界

domain: 事業所
endpoint は各 backend の S2S scoped OpenAPI artifact から同期しています。
company 境界は backend で検証します。
write 系 endpoint は、画面用 API と endpoint を分け、処理本体は service 層で共通化します。