Conectați-vă la API-uri fără cod: 8 pași

2024 Autor: John Day | [email protected]. Modificat ultima dată: 2024-01-30 11:42

Acest ghid este conceput pentru persoanele care doresc să realizeze ceva ce necesită utilizarea unui API, dar nu sunt foarte siguri cum să înceapă. Știți deja de ce este util să puteți lucra cu un API și acest ghid vă va arăta cum să faceți acest lucru.

Dacă sună ca tine, ai noroc! Suntem aici pentru a explica cum să lucrați cu API-urile, cum să citiți documentele API și cum să utilizați efectiv datele care revin dintr-un API.

Am adus un prieten pentru a face călătoria mult mai ușoară.

Faceți cunoștință cu Slash

Slash este câinele adorabil și adorabil al lui Michelle (în imaginea de mai sus). Michelle este un inginer software care construiește API-uri. Michelle se bucură cu adevărat de slujba ei și s-a inspirat din munca ei de construire a API-urilor în formarea Slash.

După cum probabil știți, un API este o colecție de comenzi pe care un utilizator le poate da unui serviciu web împreună cu un set de răspunsuri care corespund cererii. Michelle l-a antrenat pe Slash să facă la fel. Slash este un băiat bun, cunoaște o varietate de comenzi și răspunde întotdeauna corect atâta timp cât îi dai o cerere care a fost învățat. Când devine extrem de entuziasmat, coada îi înnebunește - nu este ceva ce Michelle l-a învățat în legătură cu API-urile, ci doar pentru că este un pui adorabil și se bucură cu adevărat de antrenament!

Pasul 1: decideți ce API aveți nevoie

Ce informații căutați sau doriți să modificați?

Încercați să luați toate postările Instagram ale lui @ dougthepug? Poate că doriți să trimiteți automat tweet la oricine urmărește twitter-ul câinelui dvs. (pentru că, deși câinii nu pot vorbi, au multe de spus, știm că Slash este sigur că da).

Dacă știți deja site-ul sau API-ul la care încercați să vă conectați, mergeți direct la Pasul 2. Dacă încercați să găsiți date, dar nu sunteți sigur de unde să începeți, Google vă este prieten. Căutați „[chestii care vă interesează] API” și vedeți ce apare. S-ar putea să fiți surprinși de câtă informație există acolo.

Dacă doriți un exemplu simplu de API, îl puteți folosi pe cel realizat de Michelle în timpul antrenamentului Slash. Are câteva dintre comenzile sale preferate, cum ar fi recuperarea bilelor și săparea găurilor. Îl vom folosi în restul exemplelor noastre.

Pasul 2: Găsiți documentele API

API-urile furnizate de companii bine-cunoscute ar trebui să aibă documentație aprofundată cu privire la modul de utilizare a acestora.

Pentru a le găsi, accesați documentația API „[Insert Company] API” sau „Developer [Insert Company]”.

Rezultatele ar trebui să vă ducă la portalul pentru dezvoltatori. Căutați un link care scrie „Documente”, „Documentație”, „Referință” sau „Referință tehnică”.

În documente, poate fi necesar să căutați API-ul specific pe care îl doriți, deoarece uneori pot exista multe opțiuni. Facebook, de exemplu, are API-uri separate pentru marketing, reclame, pagini și multe altele.

Dacă API-ul la care doriți să vă conectați nu este bine cunoscut (cum ar fi Slash's), poate fi necesar să solicitați documentației dezvoltatorului. Este posibil să aibă un PDF care conține informațiile de care aveți nevoie sau documentație online care nu este listată pe site-ul lor web.

Dacă ați pierdut linkul în pasul anterior, documentele API Slash pot fi găsite aici.

Pasul 3: Găsiți punctul final

Documentele API pot părea descurajante, dar odată ce știi ce să cauți, acestea sunt de obicei bine structurate și destul de standardizate.

Primul lucru pe care trebuie să îl căutați este punctul (punctele) final (e) adecvat (e). Ar trebui să existe un punct final corespunzător fiecărui tip de date dorit. Un punct final ar putea arăta astfel:

slashtheapidog.com/api/bones/{id}

sau doar

/oase

Documentația ar trebui să aibă o listă de puncte finale. Ele pot fi de nivel superior în documente sau sub o secțiune numită „referință”, „puncte finale” sau „metode”. Pentru a găsi punctul final potrivit, căutați numele care corespunde cu datele pe care le căutați. De exemplu, dacă doriți o listă cu toate găurile pe care Slash le-a săpat, / găurile este probabil cea potrivită. În orice caz, fiecare punct final ar trebui să aibă o descriere care să ajute la explicarea a ceea ce face.

Din documentele sale, acestea sunt punctele finale din API-ul Slash legate de găuri:

OBȚINEȚI

OBȚINEȚI

POST

PUT

POST

Pasul 4: Determinați tipul de solicitare

Acum că ați găsit punctul final corect, trebuie să determinați tipul de cerere pentru a-l trimite.

Există 4 tipuri diferite de solicitări:

OBȚINE

O solicitare GET este modul în care solicitați API-ului să răspundă cu ceva pe care îl are, cel mai adesea date. Puteți solicita informații specifice despre un articol sau un grup de articole pe baza punctului final și a parametrilor. Acesta este echivalentul cererii lui Slash să vă aducă unul dintre oasele sale sau toate oasele sale.

POST

O cerere POST este modul în care spuneți API-ului să creeze ceva nou. Acest lucru este similar cu cererea lui Slash să vă sape (să creeze) o nouă gaură pentru dvs.

A PUNE

O cerere PUT este modul în care spuneți API-ului să actualizeze ceva care a fost creat anterior. Acest lucru este similar cu cererea lui Slash de a săpa mai adânc (actualiza) în gaura pe care a săpat-o.

ȘTERGE

O cerere ȘTERGERE este modul în care spuneți API-ului să șteargă ceva care a fost creat anterior. Acest lucru este similar cu cererea lui Slash să acopere (șterge) o gaură pe care a săpat-o anterior.

Gândiți-vă la aceste patru tipuri. Obțineți informații, creați o intrare nouă, modificați o intrare existentă sau ștergeți una? Acest răspuns vă spune exact de ce tip de cerere aveți nevoie.

Pasul 5: Înțelegeți parametrii

Multe cereri necesită parametri suplimentari. Parametrii sunt detaliile solicitării dvs. De exemplu, dacă doriți ca Slash să vă aducă toate bilele roșii, trebuie să specificați culoarea. Dacă vrei să creeze o gaură nouă, trebuie să-i spui unde să o pună și cât de adânc să sapă.

Documentația API la care faceți referire ar trebui să aibă o secțiune numită „Parametri” sau „Opțiuni” pentru fiecare punct final și tip de solicitare. Acordați atenție parametrilor necesari, deoarece unii sunt opționali. Dacă un parametru este marcat ca opțional, documentele pot oferi un exemplu care este, de asemenea, implicit.

Parametrii API ai lui Slash ar putea arăta cam așa pentru recuperarea bilelor:

OBȚINEȚI

Pasul 6: Formatați solicitarea

Avem toate informațiile de care avem nevoie, acum trebuie doar să facem cererea!

Iată două moduri diferite de conectare la un API care nu necesită cod. Haideți să ne conectăm la API-ul Slash pentru a obține lista sa de mingi făcând o solicitare GET la

Parabola - dacă doriți să vă conectați și să lucrați cu date fără cod

Parabola este o aplicație web care vă permite să vă conectați cu ușurință la API-uri și apoi să lucrați cu datele printr-un instrument vizual, drag-and-drop.