Ce este un API? Și alte acronime: REST, SOAP, XML, JSON, WSDL

Când utilizați un browser, browserul dvs. face solicitări de la serverul clientului, iar serverul trimite înapoi date pe care browserul dvs. le adună și cu care afișează o pagină web. Dar ce se întâmplă dacă ai vrea doar ca serverul sau pagina web să vorbească cu un alt server? Acest lucru ar necesita să programați într-un API.

Ce înseamnă API?

API este un acronim pentru Interfața de programare a aplicațiilor (API). Un API este un set de rutine, protocoale și instrumente pentru construirea de aplicații bazate pe web și mobile. API-ul specifică modul în care vă puteți autentifica (opțional), solicita și primi date de la serverul API.

Ce este un API?

Un API este în esență un set de reguli și specificații care permite diferitelor aplicații software să comunice și să interacționeze între ele. Acesta acționează ca mesager sau intermediar, permițând unei aplicații să solicite date sau servicii de la o alta și apoi să primească un răspuns înapoi.

Să oferim un exemplu simplu. Dacă utilizați un scurtator de legături pentru a distribui un lung URL-ul mai ușor mai bine, ați putea folosi un serviciu de genul Bit.ly. Tastați adresa URL lungă, trimiteți adresa URL și Bit.ly răspunde cu adresa URL scurtă.

Ce se întâmplă dacă ați dori să utilizați Bit.ly în cadrul unei platforme pe care o utilizați? Poate ați creat un generator de coduri QR online, dar doriți ca mai întâi adresele URL lungi să fie scurtate. În acest caz, puteți programa site-ul dvs. să trimită solicitarea către API-ul Bit.ly și apoi să captați răspunsul pentru a vă construi codul QR.

Procesul este automatizat cu un API unde nu este necesară intervenția umană. Aceasta este oportunitatea pe care API-urile o oferă fiecărei organizații. API-urile asistă sistemele în sincronizarea datelor, procesarea cererilor și automatizarea proceselor efectuate de obicei manual.

Dacă o platformă are un API robust, înseamnă că puteți atât integra, cât și automatiza, economisind timp manual, îmbunătățind capabilitățile în timp real ale platformelor dvs. și asigurând o acuratețe îmbunătățită, evitând problemele cu introducerea manuală a datelor.

Un videoclip despre cum funcționează API-urile

Dacă sunteți un dezvoltator de platforme, API-urile oferă, de asemenea, posibilitatea de a vă separa interfața cu utilizatorul de interogările dvs. de calcul și baze de date. De ce este asta important? Pe măsură ce vă dezvoltați interfața cu utilizatorul, puteți utiliza aceleași API-uri pe care le publicați pentru alte terțe părți. Vă puteți rescrie interfața cu utilizatorul fără să vă faceți griji cu privire la întreruperea integrării back-end.

Cum să găsiți API-urile disponibile

Căutați un API pentru un anumit produs sau serviciu? Iată câteva resurse care listează API-urile pe care le puteți utiliza personal și comercial:

Lista API-urilor RapidAPI

Cum se testează API-urile

Un API este pur și simplu o solicitare HTTP, la fel ca un browser. Diferențierea este că un API necesită adesea o metodă de autentificare pentru a face cererea. Dacă nu este necesară autentificarea, puteți chiar să solicitați prin lipirea adresei URL a solicitării într-un browser. Iată un exemplu de solicitare către un API meteo open-source.

Folosind OSX, puteți utiliza cURL comandă într-o fereastră de terminal. La executarea comenzii, cURL va face o solicitare GET la adresa URL API furnizată, iar răspunsul care conține datele de prognoză meteo va fi afișat în Terminal.

curl "https://api.open-meteo.com/v1/forecast?latitude=52.52&longitude=13.41&current_weather=true&hourly=temperature_2m,relativehumidity_2m,windspeed_10m"

Pe Windows, puteți instala curl și adăugați-l la PATH a sistemului pentru ca comanda să funcționeze. Alternativ, puteți utiliza terțe părți curl executabile pentru Windows, cum ar fi cURL pentru Windows or curl pentru Windows de la Winamp și rulați comanda curl în mod similar.

Iată câteva limbi suplimentare și cum puteți face o solicitare API:

• Piton: requests biblioteca este folosită în mod obișnuit pentru a face cereri HTTP în Python. Iată un exemplu:

import requests

response = requests.get('https://example.com')
print(response.text)

• JavaScript (Node.js): axios biblioteca este un client HTTP utilizat pe scară largă pentru Node.js. Iată un exemplu:

const axios = require('axios');

axios.get('https://example.com')
   .then(response => {
      console.log(response.data);
   })
   .catch(error => {
      console.error(error);
 });

• JQuery: Folosește $.ajax or $.get funcții pentru a face cereri HTTP. Iată un exemplu de realizare a unei cereri GET folosind $.ajax în jQuery:

$.ajax({
  url: 'https://example.com',
  method: 'GET',
  success: function(response) {
    console.log(response);
  },
  error: function(error) {
    console.error(error);
  }
});

• Rubin: Biblioteca standard a lui Ruby include net/http modul pentru efectuarea cererilor HTTP. Iată un exemplu:

require 'net/http'
require 'uri'

uri = URI.parse('https://example.com')
response = Net::HTTP.get_response(uri)
puts response.body

• Java: Java oferă diverse biblioteci și cadre pentru a face cereri HTTP, cum ar fi HttpURLConnection (în biblioteca standard), Apache HttpClient sau OkHttp. Iată un exemplu de utilizare HttpURLConnection:

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class Main {
     public static void main(String[] args) throws IOException {
       URL url = new URL("https://example.com");
       HttpURLConnection connection = (HttpURLConnection) url.openConnection();
       connection.setRequestMethod("GET");

       BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
       String line;
       StringBuilder response = new StringBuilder();
       while ((line = reader.readLine()) != null) {
         response.append(line);
       }
       reader.close();

       System.out.println(response.toString());
     }
}

• C# sau ASP.NET: Folosește HttpClient clasa pentru a face cereri HTTP. Iată un exemplu despre cum să faci o solicitare GET folosind HttpClient în C#:

using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using (HttpClient client = new HttpClient())
        {
            HttpResponseMessage response = await client.GetAsync("https://example.com");
            response.EnsureSuccessStatusCode(); // Ensure a successful response

            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
    }
}

Nu uitați să adăugați necesarul using declarații și gestionați excepțiile în mod corespunzător atunci când lucrați cu HttpClient în aplicația dvs. ASP.NET sau C#.

• WordPress: API-ul WordPress are propriile sale funcții wp_remote_get or wp_remote_post:

$response = wp_remote_get('https://example.com');

if (is_wp_error($response)) {
    $error_message = $response->get_error_message();
    echo "Request failed: $error_message";
} else {
    $body = wp_remote_retrieve_body($response);
    $data = json_decode($body);

    // Process the retrieved data
    var_dump($data);
}

Aceste exemple demonstrează cum se efectuează o solicitare GET de bază, dar aceste biblioteci acceptă de obicei diferite metode HTTP (GET, POST etc.) și oferă opțiuni pentru setarea antetelor, trimiterea sarcinilor utile de solicitare și gestionarea răspunsurilor într-un mod mai avansat.

Nu uitați să instalați orice dependențe sau biblioteci necesare pentru limbajul dvs. de programare înainte de a rula exemplele de cod.

Talend are o aplicație Chrome excelentă pentru a interacționa cu API-urile și pentru a vedea răspunsurile acestora dacă doriți să testați API-urile fără a scrie o linie de cod.

Adăugați API Tester Talend la Chrome

Ce înseamnă Acronim SDK?

SDK este un acronim pentru Kit pentru dezvoltatori de software.

Când o companie își publică API-ul, există de obicei documentație însoțitoare care arată cum se autentifică API-ul, cum poate fi interogat și răspunsurile adecvate. Pentru a ajuta dezvoltatorii să aibă un avans, companiile publică adesea un kit pentru dezvoltatori de software (SDK) pentru a include cu ușurință o clasă sau funcțiile necesare în proiectele pe care le scrie dezvoltatorul.

Ce înseamnă acronimul XML?

XML este un acronim pentru Limbaj de marcare extensibil. XML este un limbaj de marcare folosit pentru a codifica datele într-un format care este atât citibil de om, cât și citibil de mașină.

Iată un exemplu al modului în care apare XML:

<?xml version="1.0"?>
<product id="1">
<title>Product A</title>
<description>The first product</description>
<price>
<amount>5.00</amount>
<per>each</per>
</price>
</book>

Ce înseamnă acronimul JSON?

JSON este un acronim pentru Notare obiect JavaScript. JSON este un format pentru structurarea datelor care sunt trimise înainte și înapoi printr-un API. JSON este o alternativă la XML. API-urile REST răspund mai frecvent cu JSON – un format standard deschis care utilizează text care poate fi citit de om pentru a transmite obiecte de date constând din perechi atribut-valoare.

Iată un exemplu al datelor de mai sus folosind JSON:

{
"id": 1,
"title": "Product A",
"description": "The first product",
"price": {
"amount": "5.00",
"per": "each"
}
}

Ce înseamnă acronimul REST?

REST este un acronim pentru Transfer de stat reprezentativ stil arhitectural pentru sistemele hipermedia distribuite.

Vai ... respirație profundă! Puteți citi întregul disertație aici, denumite Stiluri arhitecturale și proiectarea de arhitecturi software bazate pe rețea, prezentate în satisfacția parțială a cerințelor pentru gradul de DOCTOR în filozofie în informatică și informatică de către Roy Thomas Fielding.

Mulțumesc, Dr. Fielding!

Ce înseamnă acronimul SOAP?

SOAP este un acronim pentru Protocol simplu de acces la obiecte

Nu sunt programator, dar în opinia mea, dezvoltatorii care iubesc SOAP fac acest lucru pentru că pot dezvolta cu ușurință cod într-o interfață de programare standard care citește Limbajul de definire a serviciului web (wsdl) fișier. Nu trebuie să analizeze răspunsul, acesta este deja realizat folosind WSDL. SOAP necesită un plic programatic, care definește structura mesajului și modul de procesare a acestuia, un set de reguli de codificare pentru exprimarea instanțelor tipurilor de date definite de aplicație și o convenție pentru reprezentarea apelurilor și răspunsurilor de procedură.

Legate de Martech Zone Conţinut

Peste 50 de întrebări pe care ar trebui să le puneți despre API-ul unui furnizor înainte de a selecta o platformă

Automatizați construirea API-ului REST, a panoului de administrare și a documentației Postman

WordPress: Cum să adăugați o coloană sortabilă pentru a afișa un câmp personalizat pe pagina de administrare a tipului de postare personalizat

Insurtech: Cum API-urile de asigurări transformă industria asigurărilor