🚧

What's New in bizAPIs 3.0

Enhanced Error Responses with bizAPIs Status Codes

bizAPIs 3.0 introduces structured error responses with dedicated bizAPIs status codes, making debugging faster and support interactions more efficient. All error responses now include detailed metadata like requestId, errorCode, and errorName to help you quickly identify and resolve issues.

Availability by Environment

Environment	Status
📚 Documentation	✅ Available
🧪 QUAL	✅ Available
🚀 Production	⏳ Coming Soon

Learn more about error handling →

JSON Schema API Response

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "requestId" : {
          "type" : "string",
          "description" : "Identificador único do pedido"
        }
      }
    },
    "file": {
      "type": "string",
      "description": "Ficheiro PDF em base 64"
    }
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "requestId" : {
          "type" : "string",
          "description" : "Unique request identifier"
        }
      }
    },
    "file": {
      "type": "string",
      "description": "Encoded base 64 file."
    }
  }
}

Best Practices

• Always log the requestId - Include it when contacting support for faster issue resolution
• Use errorCode or errorName for programmatic error handling in your application
• Reference the timestamp for correlating errors with your application logs

📖 View complete error codes reference →