Account Onboarding Using Axway SecureTransport APIs: Postman

August 12, 2024

Account onboarding using Axway SecureTransport APIs simplifies and automates the setup process for new users. This video clip demonstrates how to onboard accounts using an API in Axway SecureTransport. In this example, we are using POSTMAN to issue the APIs.

So now let's build our scenario. I'm using a client called Postman, which is a popular client for APIs. The beauty of this is that it will store all of the JSON for you without you having to type it in again. Here's the set of APIs that we're going to issue to create our flow.

The first thing I'm going to do is authenticate. There's an API called "myself", so if I hit send, the API was issued, we got success, and we got a return JSON message with a variable of "message: logged in".

At this point, I can create an account. Here's the JSON for that; it's a straightforward user account with the account name, folder UID, etc. Again, we got success back.

We'll create the two transfer sites. The input transfer site is going to be a folder monitor, so here's the folder that we're going to be reading from. We're just going to be pulling any files from there. Let's create that; again, success.

We'll create the outbound SFTP transfer site. Here it is; it's going to "This Server" with a Port, nothing too complicated there.

Then we'll create the subscription. Here's the JSON for subscription.

Next, slightly unusually, we're going to create the simple route first. If we look at the body for that, here it is; it consists of two steps: a rename and a send to partner, which is the step used for transferring or sending to a transfer site. Let's create the simple route; that's created.

And then we're going to tie that simple route to a template route. Here's our template route; that one is created.

Finally, we create the package route on the account itself. Here it is, and now we have our entire account flow created.

So here's my secure transport. If I just refresh that, we've just created this account. Here, you'll see that we have the two transfer sites, we have the subscription, and we have the associated route with the inherited template route with a rename and send to partner. So when this thing triggers, the flow should actually work. I'll just manually trigger it.

Go here, retrieve files... now. And there you see that we had the folder monitor reading in the file there, we have the transmitted file using SFTP, and the rename step.

Previous Video
Using APIs to Query in Axway SecureTransport
Using APIs to Query in Axway SecureTransport

This video clip demonstrates how to use APIs to make a query in Axway SecureTransport.

Next Video
Account Onboarding Using Axway SecureTransport APIs: accountSetup
Account Onboarding Using Axway SecureTransport APIs: accountSetup

This video clip demonstrates how to onboard accounts using the accountSetup API in Axway SecureTransport.