Actcast API

You can automate device operations by using the Actcast API.

Actcast API v0

See the API reference for details. (Currently only available in Japanese)

API token

An API token is required to use the Actcast API. Tokens are tied to the user who created them, and each token has a role.

When the user who created a token is removed from the group, the tokens they created are deleted as well. See Taking inventory of API tokens so that system integrations using a token do not stop unexpectedly.

Generating an API token

1. Click the Manage API Token button on the group settings page.
   
2. Click the Generate New button on the API token list page.
   
3. Generate a token. The roles that can be associated with the token differ depending on the user’s role. See roles for details.
4. Make sure to copy the generated token because this is the only time it will be displayed.
   

Roles

Note that changing the owner’s role does not affect the token’s role.

Admin

You can specify any role to generate a token.

If not Admin

When generating a token, the token will be assigned the same role as the owner.

API token management

Open the API token list page from Manage API Token on the group settings page. The list shows the following items.

Item	Description
Owner	The email address of the user who created the token
Role	The role assigned to the token
API Token	The token string. Every character but the first few is masked
Generated	The date and time the token was created
Last used	The date and time the token was last used to call the Actcast API
Description	A free-form note, for example what the token is used for

When Last used shows -, the token has either never been used, or it was last used before the feature that records the last used time became available. These two cases cannot be distinguished. For tokens created before that point, - is not evidence that the token is unused.

A filter by owner is shown on the API token list page only if you are an Admin. You can also sort by the Owner, Role, Generated and Last used columns by clicking their headers. The number of rows per page can be set to 10, 25, 50 or 100.

API token details page

Clicking a row on the API token list page opens the API token details page for that token. It shows the same items as the list, and lets you edit the description and delete the token.

Editing the description

The description can be changed after the token is generated. Click the icon next to the description on the API token details page.

Only the user who created the token can edit its description. Even an Admin cannot edit the description of a token created by another member.

Deleting a token

Click a row on the API token list page to open the API token details page, then delete the token from the menu at the right of the title. To prevent accidental deletion, a confirmation dialog asks you to type the name of the operation.

Differences by role

Admin

• You can view tokens generated within the group on the API token list page and the API token details page.
• You can delete tokens generated within the group.

If not Admin

• You can view your own tokens on the API token list page and the API token details page.
• You can delete your own tokens.

Taking inventory of API tokens

Because a token is tied to the user who created it, the token is deleted when that user is removed from the group, for example when they leave the company or move to another team. Take inventory before a member is removed from the group so that tokens used for system integrations do not expire without notice.

Checking before removing a member

When you try to remove a member who owns API tokens from the group, a confirmation dialog appears. The dialog shows how many tokens the member owns, and warns that removing the member also deletes the tokens and cannot be undone. To go through with the removal, you must type the name of the operation.

The same information is shown on the member details page when an Admin opens it, so you can check whether a member owns tokens before starting the removal.

From either place, you can jump to the API token list page filtered down to the tokens that member created.

Finding tokens that need to be handed over

If you can still reach the member who is being or has been removed, ask them to hand over the tokens they created.

If you cannot reach them, the last used time is a useful clue. A token whose last used time keeps being updated even though its owner is no longer in the group is likely to be used by some system integration. Sorting the API token list page by Last used makes such tokens easier to find.