1. <?php
  3. /**
  4. * Archives API responses with validation checks and defensive coding.
  5. *
  6. * @param string $apiUrl The API endpoint URL.
  7. * @param array $headers Optional HTTP headers.
  8. * @param array $data Optional data to send with the request.
  9. * @param string $archiveDir The directory to store the archived responses.
  10. * @return array|null An associative array containing the response data,
  11. * status code, and any errors. Returns null on failure.
  12. */
  13. function archiveApiData(string $apiUrl, array $headers = [], array $data = [], string $archiveDir = 'api_archives'): ?array
  14. {
  15. // Defensive check: Ensure the API URL is valid.
  16. if (empty($apiUrl)) {
  17. error_log("Error: API URL is empty.");
  18. return null;
  19. }
  21. // Ensure archive directory exists and is writable.
  22. if (!is_dir($archiveDir) || !is_writable($archiveDir)) {
  23. error_log("Error: Archive directory '$archiveDir' does not exist or is not writable.");
  24. return null;
  25. }
  27. try {
  28. // Make the API request.
  29. $response = file_get_contents($apiUrl);
  31. if ($response === false) {
  32. $error = "Error: Failed to fetch data from API '$apiUrl'.";
  33. error_log($error);
  34. return ['error' => $error];
  35. }
  38. // Validate the response.
  39. $statusCode = (int)substr($response, 0, 3); // Extract status code from the beginning of response
  40. if ($statusCode < 200 || $statusCode >= 300) {
  41. $error = "Error: API returned an invalid status code: $statusCode. Response: $response";
  42. error_log($error);
  43. return ['error' => $error];
  44. }
  47. // Archive the response.
  48. $timestamp = date('YmdHis');
  49. $archiveFilename = $archiveDir . '/' . $timestamp . '_' . basename($apiUrl);
  51. file_put_contents($archiveFilename, $response);
  52. error_log("API response archived to: $archiveFilename");
  55. // Decode the response (assuming JSON).
  56. $data = json_decode($response, true); // Decode to associative array
  58. if (json_last_error() !== JSON_ERROR_NONE) {
  59. $error = "Error: Failed to decode JSON response: " . json_last_error_msg();
  60. error_log($error);
  61. return ['error' => $error];
  62. }
  65. return ['data' => $data, 'statusCode' => $statusCode];
  67. } catch (Exception $e) {
  68. error_log("Exception: " . $e->getMessage());
  69. return ['error' => "An unexpected error occurred: " . $e->getMessage()];
  70. }
  71. }
  73. ?>

Add your comment