API Call
Function: API_CALL
The API_CALL function sends an HTTP request through one of the API configurations stored in TEO. This function is essential for testing interactions with external APIs.
The request is sent by the TEO platform, not by the test device, using the configuration's stored address, method, headers and credentials. A failure of this step is therefore not a device fault.
Supported on: any device; the step runs on the platform.
Parameters¶
| Parameter Name | Description | Example Values | Required | Default Value |
|---|---|---|---|---|
| API_CALL_CONFIG | The API configuration to call. Select one of the configurations created under External API; see How to create API Configuration. In an API payload, give the configuration's id. | My operator API | Yes | The first configuration in the list |
| EXPECT | The expected result of the API call attempt. It defines what constitutes a successful API call. | SUCCESS, FAIL |
Yes | SUCCESS |
To try a configuration on its own, see How to execute an API Configuration.