Hilokal B2B API (1.5.0)

Creates an opaque, one-time URL that the partner application opens in Chrome Custom Tabs or SFSafariViewController. The API key remains on the partner backend; the returned URL contains no user or site personal data.

externalUserId and site.id must be stable identifiers from the partner system. A previously unknown user is provisioned without a separate signup. The same user ID is reused on later launches, with its name, language, role, and current site assignment updated.

Each partner site ID is permanently mapped to one HiWorker department. Existing sites should be reconciled before rollout using the partner's site catalog. If an unmapped site is first encountered at launch time, an exact existing department code match is reused; otherwise a new isolated department is provisioned using site.name. Display names are never treated as identity. If multiple existing departments match, HiWorker does not guess: it provisions an isolated department so that the launch can continue and marks it for later reconciliation. Later launches reuse the mapping even if the site's name changes. Optional project.id is retained as launch context but never used as the site/department mapping key because one site may contain multiple projects.

The launch URL expires after 90 seconds and can be redeemed once. Successful redemption creates an eight-hour HttpOnly web session and redirects to the requested HiWorker web destination.

HiWorker administrators may block new web access for a specific site. A valid, authenticated request for a blocked site.id still returns HTTP 200 with the same launchUrl/expiresAt/expiresInSeconds fields. That URL is a denial-only, one-use link valid for 90 seconds. It opens HiWorker's localized access-restricted page without provisioning a user or issuing a session cookie. Partners continue opening launchUrl as usual; no special error handling is required for site restrictions. These attempts are metered as non-billable with internal error code site_access_blocked, not as successful service access. Invalid API keys, scopes, IP allowlists, and request validation still use the existing error responses. The restriction applies to every user and project at that site, including new users; it does not revoke the company's API key. An unused launch URL is checked again at redemption. If the site has since been blocked, no session cookie is issued and the browser is redirected to a localized access-restricted screen. Already authenticated web sessions retain their existing expiry; active TBM/translation connections are not forcibly terminated. After access is restored, request a fresh launch URL. A denial-only URL never grants access, even if access is restored before it is opened.

Returns active organization memberships whose user accounts have not been deleted. The organization is always derived from x-api-key; it cannot be selected with a request parameter.

Organization-access keys require the users:read scope and may omit the calling-user email. Legacy-email keys explicitly provisioned with users:read must identify an active manager, department manager, or super administrator. Regular members cannot list other users.

Results use natural display-name ordering, so names ending in numbers sort numerically. order controls the direction of that ordering.

Returns sessions created by HiWorker's live-translation feature, including sessions that do not have an AI-generated summary. Use each sessionId with live-translations to retrieve its translation segments.

This is separate from the combined Translation History dataset. Use translation-history-sessions for eligible 1:1, meeting, TBM, field-display, and Desktop Translator records.

Returns the list of translation session summaries for the organization.

Returns the detailed source/target translation segments for one session.

Returns eligible 1:1, meeting, TBM, field-display, and Desktop Translator session records. It applies the same organization, useful-content, configured minimum-duration, date, and pagination rules used by the HiWorker Translation History dashboard, while also including unmatched records from the legacy live-translation archive. The sessionType value identifies which kind of session each row represents, while historySource identifies which history store owns its ID.

For historySource=normalized, use a returned sessionId with translation-history-transcriptions to retrieve speech content and translation-history-images to retrieve historical board images. Legacy records use the existing Live Translation endpoints. Managers see all sessions in the organization; regular members see only sessions they ran themselves.

Normalized translation-history IDs belong to a different ID space from Live Translation IDs. Always use historySource when storing or routing a returned sessionId.

Returns the useful content recorded during one session: each source transcription and all translations generated from it. Rows rejected by transcription quality filtering are omitted. The top-level board and images fields include the historical board snapshot, and image translations recorded during the session. Each image item represents one recorded translation and includes its source and translated temporary download URLs. This endpoint does not create new image translations.

Transcriptions are paginated; every translation belonging to a returned transcription is included in that transcription's translations array. Continue requesting pages until all pagination.totalCount transcriptions have been received. The totals block reports complete session-level transcription and translation counts independently of the current page.

Managers can fetch content for any session in the organization; regular members only for sessions they ran themselves.

Returns the board version used by the session together with the image translations that were actually requested while that session was running. Each item represents one recorded translation and contains temporary URLs for the source and translated image. Source images that were never translated are not returned. This endpoint does not create new translations.

Store the image translation id, not the temporary URLs. Use translation-history-images/{imageTranslationId} to request fresh URLs. The URLs are intentionally temporary security credentials and should not be used after urlExpiresAt. Their expiration does not delete the image or history record.

Managers can fetch content for any session in the organization; regular members only for sessions they ran themselves.

Returns one image translation by its stable history ID with newly generated source and translated download URLs. The caller must be authorized to access the session that owns the image translation. Use this endpoint whenever a previously returned URL has expired. The URLs are intentionally temporary security credentials and should not be used after urlExpiresAt; the stable id is the value integrations should retain.

Returns a flat attendance log across the organization's TBM sessions. One row is one worker signature in one session — attendance evidence (참석 증적). Signers are often guests without accounts, identified by the name and phone number they entered when signing.

Managers see the full organization log; regular members see only signatures collected in sessions they ran themselves.

The signature image itself is not included here — fetch it per session via tbm-session-signatures.

Backward-compatible legacy route. Despite its historical name, this endpoint returns multiple session types, not only TBM. New integrations should use translation-history-sessions, which applies useful-content filtering and clearly identifies each supported mode.

The sessionType value identifies 1:1 conversation, meeting, TBM, field display, Desktop Translator, or an unclassified legacy session.

Returns the signatures workers submitted for one TBM session — attendance evidence (참석 증적) for that session. Signers are often guests without accounts, identified by the name and phone number they entered when signing.

Managers can fetch signatures for any session in the organization; regular members only for sessions they ran themselves.

Returns active (non-deleted) notice-board posts in the organization, with their latest version's title / content and the calling user's personal read/sign status against that latest version.

Board image markers in content are replaced with temporary signed download URLs. Use contentUrlExpiresAt to determine when to call this endpoint again for fresh URLs.

Returns each member's read/sign status against the latest version of one board post. Managers see all members; regular members see only their own row.

Note: when a board is edited a new version is created, and prior signatures no longer count — read and signed always reflect the latest version.

Board image markers in board.content are replaced with temporary signed download URLs. Use board.contentUrlExpiresAt to determine when to call this endpoint again for fresh URLs.