The Teleporte API documentation can be found here: https://apidocs.sera4.com
This page provides supplemental information and example cURL commands to assist in managing Teleporte job tracking sessions, designed to be used in conjunction with the official API documentation.
API Tokens
- API_URL_BASE= API URL obtained form the Menu --> Developers --> API Management page in Teleporte web interface. The URL looks like this: "https://tws-api-XXXXXX-XXXX-XXX-XXX-XXX.sera4.ca/v3"
- ORG_TOKEN= This token needs to be generated from the Menu --> Developers --> API Management page in Teleporte web interface.
- USERNAME= Email address of Teleporte administrator account
- PASSWORD= Password of Teleporte administrator account
- BEARER_TOKEN= When creating a Teleporte API session successfully, the response includes this token in the field "tws_token": {"tws_token_data":"<BEARER_TOKEN>"
- MEMBERSHIP_ID= When creating a Teleporte API session successfully, the response includes this token in the field "tws_memberships": [{"id":"<MEMBERSHIP_ID>"
Create Teleporte API Session
Applications need to create a Teleporte session to communicate with Teleporte.
API_URL="API_URL_BASE/sessions"
curl --location -g --request POST $API_URL \
--header 'Content-Type: application/json' \
--data-raw "{\"username\":\"$USERNAME\",\"password\":\"$PASSWORD\"}"
When a session is created successfully, the response of this API will include a BEARER_TOKEN and a MEMBERSHIP_ID.
Teleporte sessions needs to be renewed based on the expiration date/time given by the tws_token_expires_at field in the response.
List Work Sessions
API_URL="API_URL_BASE/work_sessions"
curl "$API_URL" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $BEARER_TOKEN" \
-H "tws-organization-token: $ORGANIZATION_TOKEN" \
-H "tws-membership-id: $MEMBERSHIP_ID"
Approve Work Session
SESSION_ID=ID of pending session, which can be obtained by listing work sessions.
API_URL="$API_URL_BASE/work_sessions/$SESSION_ID/approve"
curl --location -g --request PUT $API_URL \
--header 'Content-Type: application/json' \
-H "Authorization: Bearer $BEARER_TOKEN" \
-H "tws-organization-token: $ORGANIZATION_TOKEN" \
-H "tws-membership-id: $MEMBERSHIP_ID" \
--data-raw '{
"options": {
"ticket_number": "sarid123",
"tasks": ["Customer SHEQ Activities", "PDT"]
}
}'
Decline Work Session
API_URL="$API_URL_BASE/work_sessions/$SESSION_ID/decline"
curl --location -g --request PUT $API_URL \
--header 'Content-Type: application/json' \
-H "Authorization: Bearer $BEARER_TOKEN" \
-H "tws-organization-token: $ORGANIZATION_TOKEN" \
-H "tws-membership-id: $MEMBERSHIP_ID"
Assign Teleporte Key
API_URL="$API_URL_BASE/keys"
curl --location -g --request POST $API_URL \
--header 'Content-Type: application/json' \
-H "Authorization: Bearer $BEARER_TOKEN" \
-H "tws-organization-token: $ORGANIZATION_TOKEN" \
-H "tws-membership-id: $MEMBERSHIP_ID" \
--data-raw '{
"key": {
"lock_ids": [143415],
"membership_ids": ["97e9a980-9caf-4466"],
"start_date": "2025-04-15 10:00:00",
"end_date": "2025-04-15 12:00:00",
"ticket_number": "S_ID1234",
"options": {
"tasks": ["Customer SHEQ Activities", "PDT"]
}
}
}'