API POST užklausos siuntimas naudojant „JavaScript“ naudojant „Fetch“.

Supratimas, kaip siųsti API POST užklausą naudojant „Fetch“.

Siunčiant a POST užklausa yra būtinas norint dalytis duomenimis ir autentifikuoti naudojant API. Tai patikimas būdas siųsti HTTP užklausas, jei žinote, kaip naudoti JavaScript ir atnešti () technika. Tačiau tiksliai sudaryti užklausą kartais gali būti neaišku, ypač dirbant su antraštėmis, pvz., Autorizacija.

Norėdami šiuo atveju autentifikuoti, turite išsiųsti a POST užklausa į API galinį tašką. Pirmiau minėtam galutiniam taškui reikalinga specifinė struktūra, kurią sudaro maišyti kredencialai ir API raktas. Vis dėlto dažnai susiduriama su klaidomis, panašiomis į tą, kurią patiriate, ypač naudojant išorines API, kurioms taikomi griežti formatavimo reikalavimai.

Šis straipsnis parodys, kaip padaryti a POST užklausa naudojant atnešti () metodas teisingai. Diagnozuosime galimas problemas ir parodysime tinkamą antraštės formatą, kad išvengtume įprastų klaidų, tokių kaip „500 vidinė serverio klaida“, kurią patyrėte.

Kai baigsite, tiksliai žinosite, kaip sudėti ir pateikti „JavaScript“. gauti POST užklausą, kuri garantuos, kad su API bus sėkmingai susisiekta ir grąžinami reikalingi duomenys.

„JavaScript Fetch“ API, skirtos POST užklausoms, supratimas

Pagrindinis teikiamų scenarijų dėmesys skiriamas a siuntimui POST užklausa į API naudojant „JavaScript“. atnešti () metodas. Atitinkamų antraščių siuntimas, ypač Autorizacija antraštė, kurioje yra ir API raktas, ir maišos kredencialai, išlieka pagrindinis iššūkis. API tikisi šių duomenų kaip nešiklio prieigos rakto, kuris vėliau perduodamas į serverį autentifikuoti. Skelbtini duomenys, pvz., kredencialai, yra užšifruojami ir apsaugomi, kai klientas ir serveris bendrauja naudojant šią populiarią autentifikavimo techniką.

Kalbant apie HTTP užklausų siuntimą, gavimo metodas yra labai lankstus. Pagrindinė gavimo struktūra naudojama pirmame scenarijaus pavyzdyje, kur metodas nustatytas į 'POSTAS'. Tai nurodo API, kad duomenys siunčiami, o ne gaunami. Šiuo atveju, antraštes objektas yra būtinas, nes jame yra autorizacijos laukas, į kurį siunčiamas nešiklio prieigos raktas. „Content-Type: application/json“ taip pat įtrauktas siekiant informuoti serverį, kad duomenys perduodami JSON formatu. Jei serveris netinkamai interpretavo užklausą, gali atsirasti klaidų.

Kad kodas būtų suprantamesnis ir aiškesnis, pristatome async/laukti sintaksė antrajame scenarijuje. Šis metodas padeda atsakyti į asinchronines užklausas. Mes naudojame a pabandyti/pagauti blokuoti vietoj grandininio pažadų naudojimo tada () ir sugauti (). Tai palengvina kodo priežiūrą ir supaprastina klaidų tvarkymą. Jei kyla problemų dėl API atsakymo, mes ją nustatome ir įrašome išsamų pranešimą. Tai ypač naudinga šalinant klaidas, tokias kaip „500 vidinė serverio klaida“, kuri įvyko pateikiant pradinę užklausą.

Trečiajame sprendime gavimo logika yra padalinta į savo funkciją, kuriai taikoma labiau modulinė strategija ir todėl ją galima naudoti pakartotinai. Taip pat įgyvendiname paprastą vieneto testą, kuris naudoja console.assert() nustatyti, ar atsakymas į gavimo užklausą yra teisingas. Dėl modulinės struktūros galite greitai modifikuoti funkciją ir naudoti alternatyvius API galutinius taškus arba autentifikavimo metodus. Dėl integruotų klaidų apdorojimo galimybių programa vis dėlto gali pateikti įžvalgų atsiliepimą net ir tuo atveju, jei užklausa nepavyksta.

// Solution 1: Simple Fetch API with Authorization
const apiKey = 'your_api_key';
const hashedCredentials = 'your_hashed_credentials';
const url = 'https://authservice.priaid.ch/login?format=json';

fetch(url, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}:${hashedCredentials}`,
    'Content-Type': 'application/json'
  }
})
.then(response => {
  if (!response.ok) {
    throw new Error('Network response was not ok');
  }
  return response.json();
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));

// Solution 2: Fetch with Detailed Error Handling
async function postData() {
  const apiKey = 'your_api_key';
  const hashedCredentials = 'your_hashed_credentials';
  const url = 'https://authservice.priaid.ch/login?format=json';
  
  try {
    const response = await fetch(url, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}:${hashedCredentials}`,
        'Content-Type': 'application/json'
      }
    });
    
    if (!response.ok) {
      throw new Error(`Error ${response.status}: ${response.statusText}`);
    }
    
    const data = await response.json();
    console.log('Success:', data);
  } catch (error) {
    console.error('Fetch Error:', error.message);
  }
}
  
postData();

// Solution 3: Modular Fetch Function with Unit Test
const fetchData = async (apiKey, hashedCredentials) => {
  const url = 'https://authservice.priaid.ch/login?format=json';
  
  try {
    const response = await fetch(url, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}:${hashedCredentials}`,
        'Content-Type': 'application/json'
      }
    });
    
    if (!response.ok) {
      throw new Error(`Error ${response.status}: ${response.statusText}`);
    }
    
    return await response.json();
  } catch (error) {
    return { success: false, message: error.message };
  }
};

// Unit Test
const testFetchData = async () => {
  const result = await fetchData('your_api_key', 'your_hashed_credentials');
  console.assert(result.success !== false, 'Test Failed: ', result.message);
  console.log('Test Passed:', result);
};

testFetchData();

API autentifikavimo ir klaidų tvarkymo išplėtimas gavimo užklausose

Norint dirbti su API, reikia suprasti, kaip valdomos antraštės ir prieigos raktai, ypač tiems, kuriems to reikia autentifikavimas. Įprasta naudoti nešiklio žetoną Autorizacija API užklausos, kurią bandote atlikti, antraštę. Perduodant užšifruotus kredencialus, ši technika užtikrina saugų ryšį tarp jūsų kliento ir API. Jūsų maišos kredencialai ir API raktas paprastai įtraukiami į nešiklio prieigos raktą. Jis turi būti tinkamai suformatuotas, kad būtų išvengta tokių problemų kaip 500 vidinė serverio klaida.

Esminis elementas teikiant POST užklausas naudojant atnešti () tikrina, ar API gali gauti konkretaus formato ir tipo duomenis, kuriuos pateikiate. Norėdami padėti užtikrinti, kad serveris tinkamai perskaitytų jūsų užklausos turinį, galite naudoti „Content-Type: application/json“. Kartais API gali prireikti papildomų laukų POST užklausos turinyje, įskaitant formos duomenis arba užklausos parametrus, kurie iš pradžių galėjo būti neaiškūs iš dokumentacijos.

Kuriant patikimas programas, kurios palaiko ryšį su išorinėmis API, reikia atidžiai apsvarstyti klaidų valdymą. Be 500 klaidos, gali kilti papildomų problemų, tokių kaip 404 arba 400 klaidų, susijusių su netinkamais duomenimis arba klaidingais galutiniais taškais. Naudojimas a pabandyti/pagauti blokas kartu su išsamiais klaidų pranešimais ir registravimo sistemomis jūsų kode gali padėti diagnozuoti ir išspręsti šias problemas. Prieš įtraukiant užklausas į savo kodą, visada naudinga jas išbandyti tokiomis programomis kaip Postman arba Curl, kad įsitikintumėte, jog viskas veikia taip, kaip turėtų.