Creating your first Hello-World API Connector

Let's assume, firstly, you want to make a request to a very simple API method just to test if it works, just to say "hello".

This World API endpoint will be perfect for this little task:

https://sandbox.zappysys.com/api/world/hello

We will use this "hello" method as a starting point to create a Custom API Connector — the Hello-World Connector — using the API Connector File Wizard in the next section.

NOTE:

Throughout this tutorial, you'll see the term API "endpoint" used interchangeably with "method" and "action".

Let's start and create the Hello-World Connector by going through these steps:

Creating the Hello-World Connector

  1. Open ODBC Data Sources (x64):

    Open ODBC Data Source

  2. Create a User data source (User DSN) based on ZappySys JSON Driver:

    ZappySys JSON Driver
    Create new User DSN for ZappySys JSON Driver

  3. Once the data source configuration window opens, enter this URL into the text box:

    https://sandbox.zappysys.com/api/world/hello

  4. Then go to the Preview tab and try to say "Hello!" to the World!

  5. Since the test is successful, you are ready to create the Hello-World Connector:

  6. The API Connector File Wizard opens, click Next:

  7. Leave the default option, and click Next again:

  8. Just click Next in the next window:

  9. Let's give our new custom connector a name it deserves:

  10. Then just click Next in the Connection Types window:

  11. Let's name the hello endpoint (it deserves a name too!):

  12. When the next window opens, delete the default table (we won't need it for now):

  13. Finally, specify a path, where you want to save the newly created API Connector:

Now we are ready to use it! Let's see how to do that in the next section.