For consistency, you can follow or base your connector configuration on our own Connector Standards.
Connector Details #
- Name should not include any version information and exactly match the system/product’s name.
- Version should be same as API version.
- Description should be obtained from the system/product.
- Logo should be 400 x 400 pixels and scale down well.
- Individual Connectors should only use a single version of a system/product’s API, rather than some Methods using v1 endpints and others on the same Connector using v2 endpoints.
Authentication #
- Use OAuth2.0 where available as it’s the more secure option.
Methods #
Naming Convention:
- Get: Used when the method retrieves a single item
- List: Used when the method retrieves multiple items
- Create: Used when the method creates an item (Do not use add)
- Delete: Used when the method deletes an item
- Update: Used when the method updates an itemNote: When an endpoint carries out multiple functions, such as Creating or Updating, name the method logically e.g. “Create Or Update Contact”
Descriptions:
- Descriptions should be provided and end with a “.”
Functionality
- All entities should include methods for the following, unless not supported by the API:
- Get
- List New
- List Updated
- List
- Create
- Update
- Delete
Fields & Parameters #
- Descriptions should end in “.”
- Should provide lookup/triggers for IDs where possible.
- IDs should be descriptive of the method rather than generic. e.g. “Contact ID” rather than “ID”.
System Fields
- Should be in PascalCase e.g. “AddressLine1”.
- IDs should follow PascalCase e.g. “Id”.
- Should be consistent to our naming convention rather than to the API’s.
Display Names
- Each word should be separated with a space and capitalized e.g. “Address Line 1”.
- IDs should be uppercase e.g. “ID”.
