Call the SBS API

Now that you have a service access key for the SBS API, you can use it in your program code or business application.

As an example, let’s call the Email Service and send an email.

This tutorial uses the Postman desktop app as API client. As an alternative, you can use any other API client (such as cURL or Fiddler) and achieve the same result.

1. Download the Postman desktop app from https://www.postman.com/downloads/.

2. Run the app and sign up for an account (or sign in to your existing account).

3. Select an existing workspace or create a new one.

   

4. Click New, and then select GraphQL.

   

5. Enter the URL of the SBS endpoint that you want to call (in this example, https://email-api.socrate.io/graphql).

   

6. On the Authorization tab, select API Key. Set the key name to x-api-key and the key value to the secret key generated previously.

   

   For security purposes, you will likely want to click Set as Variable and store the key value as a variable. In the screen capture below, the variable name is {{SBS_ACCESS_KEY}}.

   

7. On the Query tab, click Use GraphQL Introspection. As a result, the GraphQL schema is loaded from the API.

   

8. Enter the GraphQL mutation and variables directly in the upper-right and lower-right text boxes, respectively. The code is included below, for convenience.

   

   Copy

   mutation sendMessage ($input:SendMessageInput!) {
         sendMessage(
           input: $input
         ) {
           id
           messageId
           from { name address }
           to { name address }
           subject
           textBody
         }
       }
   

   Copy

   {
         "input": {
         "to": [{ "address": "{{YOUR_EMAIL_ADDRESS}}" }],
           "subject": "Hello from Socrate Business Services!",
           "textBody": "This is a test email"
          }
         }
       
   

9. Replace {{YOUR_EMAIL_ADDRESS}} as required, and click Query to send the email. If the email was sent successfully, you are presented with a result similar to the one below: