Toggle Side Panel
Close search
Back to Tutorial

Introduction to the Cyclr Console

0% Complete
0/0 Steps
  1. Course Introduction
  2. The Console Dashboard

  3. Connectors

    Application Connectors
  4. Utility Connectors
  5. Custom Connectors
  6. Integration Templates
    Template Library
  7. Template Connectors
  8. Template Release Management
  9. Account and User Management
    Account Management
  10. User Management
  11. Settings
    General Settings
  12. Data Retention
  13. Appearance Settings
  14. GitHub Integration
  15. Testing Features
    Setting Up Error Reporting
  16. Script Testing

Custom Connector Documentation 

So as you can see here, I have a bunch of custom connectors within my account. These are connectors that you as an end user have made. So Cyclr doesn’t maintain these, we do not look after these. But you can essentially come into the custom connector page, and you can build out your own or create a new connector, what you’ll see is you have an option at the top to create a connector or far more conveniently, you can generate from an open API specification nap. You can paste in the open API URL, the JSON or the YAML. Or you can just paste it into here like this, it will work fine both ways. 

And what Cyclr will then do is generate a suite of methods based on what that JSON or what that Yamo looks like sort of similar to how postman does in appearance. 

That being said, that’s not the be all end all of the connector. So once you’ve imported something like that. Go inside and set up the authentication for the connector as well. 

So if I look at something like gas engineering software, I have a draft here. Again, all of these connectors are also emerging controls even the custom ones. As you can see, there’s an unnamed OAuth2 flow here. So by default, the Cycle won’t be able to setup the OAuth2. So there’ll be some setup once you’ve imported the cycle. If you can read the documentation and follow along, or if you know how it works, it should be fairly easy. 

But as you can see, there’s room for multiple authentication methods, some connectors, and some API’s have multiple different ways of authenticating themselves. So if I click on add authentication method here, I could add something like.

Test auth two, and now I’ve got a choice. So I can pick an API key basic authentication, oAuth one or two cover us in authentication. NetSuite oAuth, NetSuite, anyone that’s worked with it will know it’s got a particularly rigorous way of authenticating itself, or client certificate, if there’s just a client certificate that gets passed through, you can also do that. 

And if you have two of these, upon installation of the template, you will be asked which version of the authentication that you want to use in that instance. So once it’s installed like that, it will continue to use that type of authentication. If you upgrade the connector in the authenticator, you can then change the auth bar. Up until that point, it will use that type of authentication that you selected.

That’s all I’m going to cover for now because it’s going to lead into a more detailed video series on custom connectors.