Confirm access to the actual operations
An API listing in a product description leaves several questions open. Does the subscription include it? Can an authorized account create credentials with the right permissions? Does the endpoint expose the custom fields the connection needs?
Use documentation and test responses together. Keep representative responses with the connector source, including empty results and rejected requests. They give later changes something concrete to be checked against.
Scroll horizontally to view all columns.
| Operation | Questions for the API review |
|---|---|
| Read records | Are IDs stable? How are pages, deletions and custom fields returned? |
| Receive changes | Which events are available, and can a repeated event be recognized? |
| Create or update | Which fields are required, and how are validation errors returned? |
| Maintain access | Who owns the credentials, and how are expiry and renewal handled? |
Decide which system owns each value
A connector needs a rule for every value both applications can change. Decide the accepted source, transfer direction and handling of conflicting edits. Confirm how the endpoint treats an omitted field or an empty value before writing updates.
Keep those decisions in the field map. They affect the requests the connector sends and the corrections it must leave for a person to review.
Limits and recovery
Estimate the initial import separately from routine updates. Page size and batch limits determine the number of data requests; authentication, lookups and retries add to that count. Check how the vendor applies its rate limit and how an interrupted transfer resumes.
For a request that changes data, a timeout can leave the caller unsure whether the change was accepted. Agree the duplicate check or repeat-safe request mechanism before enabling retries. Log enough information to inspect the uncertain result.
The maintenance record should name the API version and the person who receives vendor notices. Changes to access, fields or endpoints can require an update even when the connector itself has not changed.
Navigation