Response shape
Response envelope
The current OpenAPI overview documents this common response shape.
{
"Status": 0,
"Data": null,
"Message": ""
}| Field | Purpose |
|---|---|
Status | Yeeflow request status. A value of 0 indicates success in the copied source. |
Data | The endpoint-specific response payload. |
Message | Detailed status or error information when available. |
Handling
Handle non-success Status and Message values
Do not assume that an HTTP response alone tells the full story. Check the documented envelope and treat non-zero Status values as operation failures unless the endpoint owner documents otherwise.
async function callYeeflow(url: string, init: RequestInit) {
const response = await fetch(url, init);
const result = await response.json();
if (!response.ok || result.Status !== 0) {
throw new Error(result.Message || "Yeeflow API request failed");
}
return result.Data;
}Integration behavior
Build for recoverable failures
- Log safe request metadata, not API keys or sensitive payloads.
- Use retry and backoff for transient failures and rate-limit responses.
- Surface Message values to operators carefully when they help resolve configuration issues.
- Design batch jobs so one failed item does not hide the status of the rest of the run.
Review item
Detailed error codes
API-owner review needed
The public OpenAPI source documents the response envelope but does not include a full custom error-code catalog. Detailed error codes and recovery guidance depend on endpoint behavior and should be added only after API-owner review.