Public API

Use ovice's public API! By linking and integrating ovice's functions with external services and systems, you can achieve more efficient organizational management and effective collaboration.


Eligible Plans

all plans

*Please note that specifications for the Free plan, such as restrictions on the number of requests, may change without prior notice.

 

Permissions Required to Generate API Key

organization owner

 

Generate API key

1. Click on the hamburger menu at the top left of the screen and select the "Organization" tab on the main menu.
The organization tab can only be accessed by organization owners.
Managing organization owners

Screenshot 2023-08-15 at 11.06.16 PM.png

2. Organization settings → API management → “Console” tab → Click “Generate API key”

3. Enter the API key name and click "Create"

3. Copy the client ID and client secret and click "Confirm and Close"

The client secret is only visible when it is generated. Be sure to copy and store it in a secure location, as you will not be able to view it again once you click "Confirm and Close."
If you close the screen without copying, please delete the API key and regenerate it.
Delete API key

 

API usage

Please refer to the following .
API reference

 

Activate/deactivate API key

Temporarily activate or deactivate an API key without deleting the configuration.

1. Click “Actions” → “Update” for API key

Screenshot 2024-01-30 at 8.13.45 PM.png

2. Select active or inactive and click "Save"

 

Delete API key

Completely remove the API key configuration.

1. Deactivate API key status Activate
/deactivate API key

2. Click “Action” → “Delete” for API key

3. Click “Delete”

 

Tips

  • One API key will be issued to each organization.
  • When running the API, run it on the server side rather than on the client side, such as a browser, to prevent outsiders from accessing the client ID and client secret.
  • If your client ID and client secret are leaked, please delete them immediately and reissue them.
    Delete API key
 
Was this article helpful?
1 out of 2 found this helpful

Articles in this section