Build Your Own Connector

The following table describes:

• The list of SDK APIs and the mandatory APIs.

• The "Order of Implementation" column to check the order of the APIs to be implemented. Empty columns represent optional APIs.

• Overview of how OpsHub will call each API and its expected response.

Sections	API Name	Required (Yes/No)	Order of Implementation	Overview
Introduction				This section will help you understand key concepts of SDK API and help you get started with it.
	SDK API URI Structure
	Error Handling
	Pagination
	Passing the Configuration Parameters to SDK APIs
Session APIs		Yes	1	API to manage sessions with the end system.
	Session – Initialize			API to initiate SDK. In this API, SDK can connect to the end system, initialize memory cache, etc.
	Session - Logout			API to cleanup / logout
Registration API		Yes	2
	Connector Metadata – Get			API to get connector metadata.
	Discovery API - Get			API to get connector discovery details.
Configuration Information APIs		Yes	3	These APIs are one of the most crucial APIs for the whole SDK to function as expected. OpsHub heavily relies on data sent as part of configuration info APIs to support multiple sync features.
	Server-Info			This API needs to return basic server related information like max page size, time zone, etc.
	Projects – List			This API needs to return all the projects that exist in the end system.
	Entity Types – List			Returns all the entity types for a given project.
	Entity Type – Get			Returns detailed configuration information for a given entity type and project.
	Lookup Field Values-Get			Returns lookup values for a given field, a given entity type.
Entity APIs		Yes	4	Entity CRUD APIs.
	Entity – Get			Gets information for a given entity id.
	Entity – Create			Creates a single entity in the end system.
	Entity – Update			Updates a single entity in the end system.
	Entity – List			Searches API on entities.
	Entity – Delete			Soft-deletes a single entity in the end system.
Substeps		No		Returns steps in which a given update needs to be broken.
	Dynamic Substeps – Get
User APIs		No		Search API on users.
	Users – List			Returns list of users matching a given search criteria.
Comments API		No		Implement these set of APIs to integrate comments.
	Add Comments			Adds a single comment in the end system.
	Get Comments			Gets all comments for a given entity.
Attachment APIs		No		Implement these set of APIs to integrate attachments.
	Attachment Content – Get			Returns attachment content in base64 format.
	Attachment – Create			Adds a single attachment in the end system.
	Attachment - Update			Updates an attachment in the end system.
	Attachment – Delete			Deletes an attachment in the end system.
	File Name – Get			Parses and returns file name in given HREF or imgsrc.
Links		No		Implement these set of APIs to integrate links.
	Link – Create or Update			Adds or updates a link.
	Link – Delete			Deletes a link.
	Get Siblings Under Parent Order By Rank			Gets siblings under parent ordered by rank.
History APIs		No		Implement these set of APIs to integrate history.
	History – List			This API is mandatory to implement if recovery.type is 'HISTORY_BASED' in entitytype - get API of configuration info category. The API should return matching history records as per the given search criteria.
	Attachment History – List			Implement this API if your end system has a separate API for getting attachment history.
	Comment History – List			Implement this API if your end system has a separate API for getting comments history.
	Link History – List			Implement this API if your end system has a separate API for getting links history.

Some Useful SDK Pages

• APIs Required for Each Feature

• SDK Best Practices