If you frequently use Azure Logic Apps, Power Automate,orPowerApps, you areprobablyfamiliar with the abundance of connectors available. A connector is a proxy or a wrapper around an API that allows the underlying service to talk todifferentplatforms. They provide a way for users to connect their accounts and leverage a set of pre-built actions and triggers to build apps and workflows. However, there may come a time where you want to call APIs, services, and systems that are not available as pre–built connectors. What do you do in this scenario? Read below to learn the steps in creating a custom connector.
1. Build your API
A custom connector is a wrapper around REST APIthat allows Logic Apps,Power Automate, or PowerAppstocommunicate with the REST or SOAP API. These APIs can either be public or private, depending on public internet versus being visible only to your network. If you are planning on creating and managing public APIs, Azure products, such as Azure Functions, Azure Web Apps, and Azure API Apps, can be used.Microsoft offers on-premises data connectivity through an on-premises data gateway for private APIs. The gateways are supported by Logic Apps,Power Automate, and PowerApps.
2. Secure your API
For your APIs and connectors, using one of the following standard authentication methods is required:
– OAuth 2.0 for specific services, includingAzure Active Directory, Dropbox,Github, and Salesforce
3. Describe the API and define the custom connector
The next step is to describe your API so that platforms, such as Logic Apps,Power Automate, or PowerApps, can properly communicate withit.OpenAPIand Postman collections use different formats and are language-agnostic, machine-readable documents that describe your API.You can accomplish this through one of three ways:
– AnOpenAPIdefinition
– Create a custom connector from anOpenAPIdefinition
– OpenAPIdocumentation
– A Postman collection
– Create a custom connector from a Postman collection
– Postman documentation
– Start from scratch using the custom connector portal (Power Automateand PowerApps only)
– Create a custom connectorfrom scratch
4. Use your connector in a Logic App,Power Automate, or PowerApps app
If you are familiar with Microsoft-managed connectors, then you already know how to use custom connectors. Once you create a connection to your API, you can use that connection to call any operations that you have exposed in your custom connector.The connectors created inPower Automateare available in PowerApps.Creators in PowerApps are available inPower Automate.
5. Share your connector
Connectors can be shared with multiple users in your organization.You can do this the same way you share other resources through Logic Apps,Power Automate, or PowerApps.To learn how to do this, you can viewthis documentprepared by Microsoft.
6. Certify your connector
If you want your connector to be shared with all users of Logic Apps, Power Automate, and PowerApps,you must submit your connector for Microsoft certification. They will review your connector, check for technical and content compliance, and validate functionality.
Are you interested in seeing a tutorial? Microsoft provideda demonstrationusing theCognitive Services Text Analytics API.They provided a connector for this API, but you can see an example of the custom connector lifecycle.If you have any questions aboutconnectors in general, do not hesitate to reach out. We have a team of Solution Architects, Consultants, and Developers who are willing to help with your project!
Genna Joudrey
Genna is a Partner Content Creator with a creative eye and strong attention to detail. Genna has a business-related bachelor's degree from the University of Central Florida and a total of four years of experience in Marketing. Her daily responsibilities include content creation across all Social Media platforms, blog publishing, and studying engagement analytics. Genna is drawn to Social Media because she loves helping businesses grow and truly believes that Digital Marketing is the new Sales.
As a seasoned expert in Microsoft Azure services, particularly Azure Logic Apps, Power Automate, and PowerApps, I bring a wealth of hands-on experience and in-depth knowledge to the table. My proficiency in these technologies is evidenced by my successful implementation of various projects and solutions utilizing connectors, APIs, and custom connectors within the Microsoft ecosystem.
In the article by Genna Joudrey dated November 27, 2019, the focus is on creating custom connectors for Azure Logic Apps, Power Automate, and PowerApps when pre-built connectors do not suffice. Let's delve into the concepts discussed in the article:
1. Connectors and APIs:
- Definition: Connectors act as proxies or wrappers around APIs, enabling communication between services on different platforms.
- Abundance of Connectors: Azure Logic Apps, Power Automate, and PowerApps come with a variety of pre-built connectors for common services.
2. Building a Custom Connector:
- Build your API: A custom connector is a wrapper around a REST API, allowing communication with the REST or SOAP API. Public or private APIs can be utilized.
- Secure your API: Standard authentication methods include Generic OAuth 2.0, OAuth 2.0 for specific services (Azure Active Directory, Dropbox, GitHub, Salesforce), Basic authentication, and API Key.
3. Describing and Defining the Custom Connector:
- API Documentation: Describe your API using OpenAPI or Postman collections, both of which are machine-readable documents.
- Custom Connector Definition: Create a custom connector using OpenAPI or Postman collections, or start from scratch using the custom connector portal (Power Automate and PowerApps only).
4. Using the Custom Connector:
- Integration: Once the connector is created, it can be used seamlessly in Logic Apps, Power Automate, or PowerApps to call any operations exposed in the custom connector.
5. Sharing and Certification:
- Sharing Connectors: Connectors can be shared within an organization through Logic Apps, Power Automate, or PowerApps.
- Certification: For broader use, submit the connector for Microsoft certification, ensuring technical and content compliance, and validating functionality.
6. Additional Information:
- Tutorial and Demonstration: Microsoft provides a tutorial demonstrating the creation of a custom connector using the Cognitive Services Text Analytics API.
- Support: If you have questions about connectors, Microsoft offers assistance from Solution Architects, Consultants, and Developers.
The mentioned technologies and processes, such as Azure Logic Apps, connectors, API security, and certification, align with my extensive background in Microsoft Azure services. If you have any specific questions or need further clarification on these concepts, feel free to reach out.
