Anatomy of an API Connector
Blog post from Prismatic
API connectors are essential tools for creating integrations within platforms like Prismatic, which offers an embedded integration platform with a variety of connectors, including one for Asana, a project management system. This Asana API connector, developed in TypeScript and compiled to JavaScript, interacts with Asana's REST API using JSON for data exchange and supports event-driven updates through webhooks. The connector comprises over 70 actions that handle CRUD operations for Asana resources such as tasks, projects, and users, and organizes code into directories for actions, inputs, triggers, and utilities to ensure maintainability and reusability. Authentication is managed through either API keys or OAuth 2.0, and the Axios library is used for HTTP requests. Best practices include wrapping API connection details in functions, creating reusable actions, integrating webhook logic into triggers, and providing clear examples and comments for inputs and payloads. These practices aim to facilitate the building of custom connectors that meet specific customer needs.