Application Connectors Authentication Guide Documentation
So here, if I come down here to the application connector library, this is a nice way for you, as the end user to be able to search through for a specific connector, or just have a browse and what we have on offer for you guys in terms of connectors API’s that we can call.
Now, the core difference between the application connector, as you can see here, and a utility connector, as you see there, an application connector is something that is external. So it goes towards or faces an external API, or Utility connector is held within the system. So it’s an internal process that helps you build out more complicated logic within your workflows.
So what kind of applications do we have in the library, we have anything ranging from Ecommerce API’s, CRM API’s, all the way down to just database connections.
So should you have an on premise SQL Server or an on premise Postgres server, anything like that, that you wish to move your information into, we can connect to that.
Now the buttons available for each connector. So as you can see, on the right hand side here, we have four options for some of the connectors three for the majority.
Now, in terms of setting up a connector, you’ll notice this padlock here is available, and it says setup required. So this is something that is only tied to OAuth2 connectors. What that means is you can set up the application externally in that system. And when you set up an OAuth to connect to it provides you with a client ID and a client secret.
So what we would then ask you guys to do is fill in the client ID in here. And what that means is your users don’t have to create an application for themselves, provided they have an account in the system. All they have to do is sign in. And they’ll just be prompted to sign in with a username and password and grant permission to your application.
Now, there’s also a callback URL. And this is in part two due to the setup of the OAuth client within the user application within the end user application. So once they’ve signed in, the callback needs to put it back into Cyclr. So that we can get the authentication key.
We can start using that and that user can be authenticated within Cyclr and their information can start flowing. It’s not on all connectors because not all connectors follow an OAuth truth though some are just API keys, some are just simple logins, that those that do support OAuth will have this setup required here, this little padlock. Or you’re also allowed to do is, or what you’ll find that you’re able to do is customise the installation user experience.
So if I click on this, here, I can set up a name, and a description. And what you’ll see on the right hand side of the screen is a small preview of what it’s going to look like to your end user. So once we set up the application, now, obviously, my camera card and partner account, but yours would be the name of your business in and of itself.
What I could do, instead of 3d Cart, I could change this to I could type anything here so and then the description, so I can just fire provide a brief description of what the user is expecting and what this really means. So as an example, 3d Cart.
Just taking this example here, just to showcase it, that is how it would appear for your users. Now, there is some degree of customization, but I’ll touch on that later on. So I don’t want to save this, I don’t want to save these changes. So I’m just gonna go back to the connector library. So that’s how you customise the appearance for your users. And that is what your end users will see when they’re prompted to sign into the 3d Cart application or any application of your choosing. So you’ll notice that this is there for everything, any application that requires setup on the user end, those screens will be surfaced for them.
The releases, so this one’s for you admins out there. This just shows what versions of a connector you have installed. All of our connectors are version control. And you can see what accounts have the release installed and what cycles have the release installed from that. It’s also some notes here. So it’s just notes that are commenting on the release version.
And finally, when you’re on the screen, if you want to look at the methods, you can have a look at this, you can click on that final burger menu there. And you can see a list of all the methods that are available for each connector. So on 3d Cart, we have eight methods available across two different folders, feed customers and orders. You can see these are all get calls that are just pulling down information from 3d Cart.