Pobieranie plików Excel (.xls) z interfejsu API przy użyciu programu Postman i innych metod

Dostęp do plików Excel poprzez API: Postman i Beyond

Pobieranie plików Excel (.xls) z interfejsu API może być kluczowym zadaniem dla programistów pracujących z aplikacjami opartymi na danych. Dzięki odpowiedniemu punktowi końcowemu API i tokenowi autoryzacji proces staje się prosty, chociaż mogą pojawić się problemy przy próbie wyświetlenia tych plików bezpośrednio w Postmanie.

W tym artykule omówiono kroki umożliwiające pobranie raportu .xls za pomocą programu Postman oraz omówiono alternatywne metody programowe umożliwiające dostęp i przeglądanie tych plików, jeśli program Postman okaże się niewystarczający. Pod koniec tego przewodnika będziesz już wiedział, jak efektywnie obsługiwać pobieranie plików .xls.

Szczegółowe wyjaśnienie funkcjonalności skryptu

Pierwszy skrypt demonstruje, jak pobrać plik Excel (.xls) z interfejsu API za pomocą programu Postman. Skrypt rozpoczyna się od zdefiniowania punktu końcowego API i tokena autoryzacji. Następnie konfiguruje nagłówki żądań za pomocą pm.sendRequest, określając adres URL, metodę i nagłówki. The responseType: 'arraybuffer' ma kluczowe znaczenie, ponieważ mówi Postmanowi, aby potraktował odpowiedź jako dane binarne, które są niezbędne do pobierania plików. Po otrzymaniu odpowiedzi skrypt tworzy plik Blob obiekt reprezentujący dane binarne. Za pomocą window.URL.createObjectURL, dla obiektu Blob generowany jest adres URL, który umożliwia pobranie pliku po kliknięciu łącza. To podejście wykorzystuje możliwości JavaScript do obsługi danych binarnych i inicjowania pobierania plików bezpośrednio z przeglądarki.

Drugi skrypt używa Pythona, aby osiągnąć ten sam cel. Rozpoczyna się od zaimportowania pliku requests bibliotekę oraz zdefiniowanie punktu końcowego API i tokena autoryzacyjnego. Nagłówki żądań są skonfigurowane tak, aby zawierały token autoryzacji i określały żądany format pliku za pomocą headers = {'Authorization': f'Bearer {auth_token}'} składnia. Skrypt wysyła żądanie HTTP GET do punktu końcowego API za pomocą requests.get. Jeśli kod stanu odpowiedzi wynosi 200, co oznacza pomyślne żądanie, skrypt zapisuje treść odpowiedzi jako plik Excel przy użyciu with open('report.xls', 'wb') as file składnia. Blok ten zapewnia otwarcie pliku w trybie zapisu binarnego i zapisanie w nim pobranej zawartości. Skrypty te zapewniają niezawodne metody programowego pobierania i zapisywania plików Excel, oferując rozwiązania zarówno dla środowisk Postman, jak i Python.

// Define the API endpoint and Authorization token
const apiEndpoint = 'https://api.example.com/download/report';
const authToken = 'your_authorization_token';

// Set up the request headers
pm.sendRequest({
    url: apiEndpoint,
    method: 'GET',
    header: {
        'Authorization': `Bearer ${authToken}`,
        'Accept': 'application/vnd.ms-excel',
    },
    responseType: 'arraybuffer',
}, function (err, res) {
    if (err) {
        console.log(err);
    } else {
        // Save the response as a .xls file
        var blob = new Blob([res.stream], { type: 'application/vnd.ms-excel' });
        var link = document.createElement('a');
        link.href = window.URL.createObjectURL(blob);
        link.download = 'report.xls';
        link.click();
    }
});

import requests

# Define the API endpoint and Authorization token
api_endpoint = 'https://api.example.com/download/report'
auth_token = 'your_authorization_token'

# Set up the request headers
headers = {
    'Authorization': f'Bearer {auth_token}',
    'Accept': 'application/vnd.ms-excel'
}

# Send the GET request
response = requests.get(api_endpoint, headers=headers)

# Save the response content as a .xls file
if response.status_code == 200:
    with open('report.xls', 'wb') as file:
        file.write(response.content)
    print("File downloaded successfully")
else:
    print(f"Failed to download file: {response.status_code}")

Alternatywne metody pobierania plików Excel z interfejsu API

Jeśli chodzi o pobieranie plików Excel (.xls) z interfejsu API, użycie Postmana jest wygodną i prostą metodą. Istnieją jednak inne podejścia programistyczne, które warto rozważyć, szczególnie w przypadku bardziej złożonych scenariuszy lub integracji procesu pobierania z większą aplikacją. Jedno z takich podejść polega na użyciu języków skryptowych po stronie serwera, takich jak Node.js lub PHP. Języki te obsługują żądania i odpowiedzi HTTP, umożliwiając automatyzację procesu pobierania. Na przykład w Node.js możesz użyć bibliotek „axios” lub „request”, aby wysłać żądanie GET do punktu końcowego API, a następnie zapisać dane binarne bezpośrednio do pliku na serwerze. Ta metoda jest korzystna, gdy trzeba zaplanować regularne pobieranie lub dokładniej przetworzyć dane przed ich zapisaniem.

Innym podejściem jest wykorzystanie rozwiązań opartych na chmurze takich jak AWS Lambda czy Azure Functions. Platformy te umożliwiają tworzenie małych, bezserwerowych funkcji, które obsługują żądania HTTP, w tym pobieranie plików z interfejsu API. Korzystając z tych usług, możesz przenieść zadanie pobierania plików do skalowalnego środowiska chmurowego, zmniejszając obciążenie lokalnego serwera lub aplikacji. Dodatkowo te funkcje chmury mogą być uruchamiane przez różne zdarzenia, takie jak dostępność nowego pliku lub określona pora dnia, co zapewnia większą elastyczność i automatyzację. Zarówno Node.js, jak i rozwiązania oparte na chmurze oferują potężną alternatywę dla Postmana do programowego pobierania plików Excel, zapewniając niezawodność i skalowalność aplikacji.