An API authentication token is required for all requests. Authentication tokens must be generated for each client through the FlowTraq command line tools. To request the token, send an HTTP request such as:
POST https://example.com/flowtraq/api/v1/auth
| Parameter Name | Value | Default Value | Notes |
|---|---|---|---|
| server | string | "localhost" | The FlowTraq server address. |
| port | number | 9640 | The FlowTraq server port. |
| username | string | required | Username of a user on the Flowtraq server. |
| password | string | required | Password of the Flowtraq server user. |
The response will contain either the resulting auth token or an error message:
| Parameter Name | Value | Notes |
|---|---|---|
| auth_token | string | Only returned if authentication successful. |
| error | string | Only returned if authentication failed. |
