Boomi can be accessed using RESTful API requests to the server.

There are multiple ways to use the RESTful interface. Some examples include:

Using an application similar to Postman.
Using a programming language like Python.

Both have useful features.

The RESTful API can be used to do many of the things the Boomi web interface can, and some things it cannot. For example, there is no way to delete some objects, like datastores, from the web interface. This design choice was intentional by the Boomi team.

Using Postman to access Boomi

Using Postman, you can see what data is returned from individual calls to the RESTful API.

The graphical interface requires no coding to make requests.

Authenticate using an HTTP POST with Boomi and receive a token.
1. Use the URL, http://<ipaddress>:8000/datai-api/get-jwt/.
2. Set the body type to Raw JSON.
3. The body data should include the username and password fields in JSON format:
```
{
	"username": "user",
	"password": "pass"
}
```

Retrieve the token from the response JSON:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDMxMzUzMjQsImV4cCI6MTYwMzEzNTkyNCwiaWQiOjIsInVzZXJuYW1lIjoidW5pZmkiLCJpcF9hZGRyZXNzIjoiMTAuMTM1LjcyLjI2In0._SrmB0QAqcCXXkuxbSEqJ0yvCK7849AeI8XOFiA9QoU",
    "refresh_token": "da719a14cae742f7b1de24ff8a65cf6e8f58c8bdd73f4a25b34ec0299b8b5da6",
    "data": null,
    "last_login": null,
    "status": "SUCCESS"
}

Use the token in subsequent HTTP GET, POST, and DELETE operations.
1. Attempt to retrieve the users from http://<ipaddress>:8000/datai-api/users/.
2. In a GET request, select the Authorization tab.
3. Choose type Bearer Token, and then place the value of the token in the Edit field.
4. Send the request.
5. Examine the output.
The token has a short life span. It is only valid for approximately 5 minutes. If you use an expired token, you get an error back from the REST call:
```
{
    "detail": "Token signature has expired",
    "status_code": 401
}
```
This limitation makes using the Postman interface cumbersome.

The Postman utility can be found at: https://www.postman.com/.

Using a programming language to access Boomi

Another way to access the API is by writing code in Python or a similar scripting language. This method makes it easier to log in and get a new token when the script is run.

If the script is more interactive and long-running, the expired token can be caught and a new token requested. Then the operation can be performed.

Create a script to perform the operation. For example:

#!/usr/bin/python3

import requests
import json


bodyStr = json.dumps({  "username" : "user",   "password" : "pass"})

# get the required token for making requests to the REST API
response = requests.post("http://127.0.0.1:8000/datai-api/get-jwt/", data=bodyStr, headers={"Content-Type": "application/json"})

if response.status_code == 200:
    # success
    responseDict = json.loads(response.text)

    # setup the requests header to pass the token
    headers = {"Content-Type": "application/json", "Authorization": "Bearer " + responseDict['token']}
    usersResponse = requests.get("http://100.84.123.12:8000/datai-api/users/", headers=headers)

    usersJson = json.loads(usersResponse.text)

    for user in usersJson:
        print(user['username'])
else:
    print("Error: " + response.text)

Run the script.
Examine the output.

Your Browser is Out of Date

RESTful API example

RESTful API example

Using Postman to access Boomi

Using a programming language to access Boomi