COmanage Match supports three types of API Users:
- Platform API Users have full access to the API.
- Matchgrid API Users have full access to a specific Matchgrid.
- System of Record API Users have authority only for records associated with a specific System of Record.
All API authentication is currently Basic Auth password over HTTPS.
Platform API Users
Platform API Users have full access to the API across all Matchgrids for configuration (not yet implemented) and data access purposes. They are effectively Platforms Administrators.
To create a Platform API User, login as a Platform Administrator and select API Users from the main menu.
.) in their usernames. A valid Platform API username might be "admin".Matchgrid API Users
Matchgrid API Users have full access to the specified Matchgrid via the API, for configuration (not yet implemented) and data access purposes. They are effectively Matchgrid Administrators.
To create a Matchgrid API User, login as a Platform or Matchgrid Administrator, select Manage for the desired Matchgrid, then select API Users from the main menu. Leave the System of Record blank.
Matchgrid API usernames must begin with the name of the Matchgrid and a period (.), for example "testgrid.". A valid Matchgrid API username might be "testgrid.admin".
System of Record API Users
System of Record API Users have full access via the API to the data for the specified System of Record within the specified Matchgrid.
To create a System of Record API User, login as a Platform or Matchgrid Administrator, select Manage for the desired Matchgrid, then select API Users from the main menu. Make sure to specify the appropriate System of Record.
System of Record API usernames must begin with the name of the Matchgrid and a period (.), for example "testgrid.". Although not required, a useful recommendation might be to use the System of Record name for the rest of the username. A valid System of Record API username might be "testgrid.sis".
See also: Accessing the Match API