Creating a Web Services API Profile

3 minutes to read

To use Web services API, you must have at least one Web services profile in your Caspio account. Web services profiles may be given specific permissions to create and access tables, views, files, webhooks, data import/export tasks, Bridge applications, and directories in the corresponding Caspio account.

To create a Web services profile:

From the top navigation bar, select Account → Access Permissions.
Click the Web services profiles tab.
Click Create web services profile.
Enter the Profile name that will help you identify this profile.
Optional: Enter the profile Description/Purpose.
Optional: Under Permissions, your profile’s permissions are selected by default. If you want to remove them, clear the following permissions as required:
- Enable access to all objects – Allows access to all tables, views, files, webhooks, data import/export tasks, Bridge applications, and directories in your Caspio account.
  If you choose not to enable access to all objects, you can add permissions manually. See Editing profile permissions below.
- Profile can create objects – Allows the profile to create tables, views, and DataPages, as well as upload Files.
Optional: In the Optional IP restrictions section, restrict the IP addresses that are allowed to access this profile:
- If you want to add specific addresses that are not allowed to access this profile, select Allow all and add IP addresses or ranges that are restricted.
- If you want to add specific addresses that are allowed to access this profile, select Deny all and add IP addresses or ranges that are allowed.
Click Create.

Your profile is now created. It contains the following information:

Integration URL: The base URL that external applications will use when connecting to your Caspio account through the Web Services API.
Token endpoint URL: Caspio OAuth 2.0 token endpoint.
Documentation URL: Link to Swagger UI.
Client ID: REST API profile username. It is generated automatically.
Client Secret: REST API profile password. It is generated automatically.

Note: You can regenerate the Client ID and Client Secret. Regenerating them invalidates all previously generated values.

Editing profile permissions

For each Web services profile, you can configure its read, update, insert, and delete permissions for tables and views.

Note: If the Enable access to all objects checkbox is selected in the current profile configuration, this profile has access to all tables and views by default.

On the list of Web services profiles, hover over a profile and click Permissions.
In the left panel, select what you want to edit this profile’s permissions for. It can be All tables, All views, or specific tables or views.
For your selection in the previous step, in the right panel, configure the permissions:
- Full control: Use this option to select all other checkboxes at once.
- Read data: The profile can access data without modifying it. This permission is automatically added if you grant the update, insert, or delete permissions.
- Update data: The profile can modify data.
- Insert data: The profile can add new records.
- Delete data: The profile can delete records.
After making changes for all required objects, click OK to save the configuration.