To use Web Services API, you must have at least one Web Services Profile in your Caspio Bridge account. Similar to users, each Web Service Profile may be given specific privileges to create and access tables, views, files and file folders in the corresponding Caspio Bridge account. However, unlike users, Web Services Profiles cannot log into Caspio Bridge interactively.

To create a Web Services Profile, select Account from the top navigation bar and select Access Permissions, then click on New Profile. You will be redirected to a form in which you can create your Web Services Profile.

Caspio Bridge supports REST and SOAP protocols. For Microsoft Office Plugin, you will need to use the SOAP profile which is explained below.

Creating a REST API Profile

To create a REST API profile, you will need to provide the following information:

  • Profile Name: Required – This is used to identify this profile in the Caspio Bridge user interface.
  • Description/Purpose: Optional profile description.
  • First Name: First Name of the person managing and using this REST profile.
  • Last Name: Last Name of the person managing and using this REST profile.
  • Email Address: Email of the person managing and using this REST profile.
  • Protocol: Should be set to REST.

The following information will be available to you for using in your REST API client or program:

  • Token Endpoint: Caspio OAuth 2.0 Token Endpoint
  • Resource Endpoint: Caspio REST API Resource URL
  • Client ID: REST API Profile’s username. It is generated automatically.
  • Client Secret: REST API Profile’s password. It is generated automatically.
  • Permissions: Quick way to provide wide access to this profile by making it a member of the Administrators group. Detailed control over the permissions of this profile is available after the profile is created, from the Web Services Profiles listing page.

Optional IP Restrictions

  • Default Access: Web Services profile access to Caspio Bridge can be limited based on client’s IP. Use this option to grant or deny access.
  • IP Address Filtering: Insert or manage the IP address filtering.

At anytime you can regenerate Client ID/Secret pair but all it will invalidate all previously generated tokens.

Creating a SOAP API Profile

To create a SOAP API profile, you will need to provide the following information.

General Information

  • Profile Name: Required – This is used to identify this profile in the Caspio Bridge user interface.
  • Description/Purpose: Optional profile description.
  • First Name: First Name of the person managing and using this SOAP profile.
  • Last Name: Last Name of the person managing and using this SOAP profile.
  • Email Address: Email of the person managing and using this SOAP profile.
  • Protocol: Should be set to SOAP.
  • Force SSL encryption: Check this option to disable API access for this profile using non-secure protocols (such as HTTP).

The following information will be available to you for using in your SOAP API client or program:

  • WSDL URL: This is the URL to access Web Services for your particular account.
  • Pass Key: This is the profile’s auto-generated password to access the Web Service.
  • Regenerate Pass Key: You can create new Pass Key or automatically regenerate it.
  • Permissions:
    • Enable access to all objects – Give the profile access to all Tables, Views, Files and File Folders in your Caspio Bridge account.
    • Profile can create objects – Allow the profile to create Tables, Views, DataPages and upload Files.
    • Enable access to all DataPages – Allow the profile to access all DataPages.

Detailed control over the permissions of this profile is available after the profile is created, from the Web Services Profiles listing page.

Optional IP Restrictions is explained in the REST API section above.

When in the edit mode, the Disable option is available to temporarily block the profile from accessing the resources of the account without having to delete it.