Connecteu-vos a API sense codi: 8 passos

2024 Autora: John Day | [email protected]. Última modificació: 2024-01-30 08:11

Aquesta guia està dissenyada per a persones que volen aconseguir alguna cosa que requereixi fer servir una API, però que no saben molt bé com començar. Ja sabeu per què és útil poder treballar amb una API i aquesta guia us mostrarà com fer-ho.

Si et sembla, estàs de sort! Estem aquí per explicar-vos com treballar amb les API, com llegir els documents de l’API i com utilitzar realment les dades que tornen d’una API.

Hem portat un amic perquè el viatge sigui molt més fàcil.

Coneix Slash

Slash és l’adorable i adorable gos de Michelle (a la imatge superior). Michelle és un enginyer de programari que crea API. A Michelle li agrada molt la seva feina i s’ha inspirat en el seu treball creant API per entrenar Slash.

Com ja sabreu, una API és una col·lecció d’ordres que un usuari pot donar a un servei web juntament amb un conjunt de respostes que coincideixen amb la sol·licitud. Michelle ha entrenat Slash a fer el mateix. Slash és un bon noi, coneix diverses ordres i sempre respon correctament sempre que li demaneu una petició. Quan s’excita més, la cua es torna boja: això no és cosa que Michelle li va ensenyar relacionat amb les API, és només perquè és un cadell encantador i gaudeix molt de la seva formació.

Pas 1: decidiu quina API necessiteu

Quina informació busqueu o voleu canviar?

Esteu intentant agafar totes les publicacions d’Instagram de @ dougthepug? Potser voleu fer tweets automàticament a qualsevol que segueixi el twitter del vostre gos (perquè, tot i que els gossos no poden parlar, tenen molt a dir, sabem que Slash sí que ho fa).

Si ja coneixeu el lloc o l'API amb què intenteu connectar-vos, aneu directament al pas 2. Si esteu intentant trobar dades, però no sabeu per on començar, Google és el vostre amic. Cerqueu l'API "[coses que us interessen]" i consulteu què apareix. Us pot sorprendre la quantitat d'informació que hi ha.

Si voleu un exemple d’API senzill, podeu utilitzar el que Michelle va fer mentre entrenava Slash. Té algunes de les seves ordres preferides com recuperar boles i cavar forats. L’utilitzarem a la resta d’exemples.

Pas 2: cerqueu els documents de l'API

Les API proporcionades per empreses conegudes haurien de tenir documentació completa sobre com utilitzar-les.

Per trobar-los, consulteu "Documentació de l'API [Insereix empresa]" o "Desenvolupador [Insereix empresa]".

Els resultats us han de portar al portal per a desenvolupadors. Cerqueu un enllaç que digui "Documents", "Documentació", "Referència" o "Referència tècnica".

Dins dels documents, és possible que hàgiu de buscar l’API específica que vulgueu, ja que de vegades hi pot haver moltes opcions. Facebook, per exemple, té API separades per a màrqueting, anuncis, pàgines i molt més.

Si l'API a la qual us voleu connectar no és ben coneguda (com la de Slash), és possible que hàgiu de demanar documentació al desenvolupador. És possible que tinguin un PDF que contingui la informació que necessiteu o documentació en línia que no aparegui al seu lloc web.

Si heu perdut l'enllaç al pas anterior, podeu trobar els documents de l'API de Slash aquí.

Pas 3: cerqueu el punt final

Els documents de l’API poden semblar descoratjadors, però un cop sabeu què cal cercar, solen estar ben estructurats i bastant estandarditzats.

El primer que heu de buscar són els punts finals adequats. Hi hauria d’haver un punt final corresponent a cada tipus de dades que vulgueu. Un punt final podria tenir aquest aspecte:

slashtheapidog.com/api/bones/{id}

o simplement

/ ossos

La documentació hauria de tenir una llista de punts finals. Poden ser de primer nivell als documents o en una secció anomenada "referència", "punts finals" o "mètodes". Per trobar el punt final adequat, cerqueu el nom que correspongui amb les dades que esteu cercant. Per exemple, si voleu una llista de tots els forats que Slash ha excavat, / holes és probablement l'adequat. En qualsevol cas, cada punt final ha de tenir una descripció que ajudi a explicar què fa.

Segons els seus documents, aquests són els punts finals de l'API de Slash relacionats amb els forats:

OBTÉ

OBTÉ

POST

PUT

POST

Pas 4: determineu el tipus de sol·licitud

Ara que heu trobat el punt final adequat, heu de determinar el tipus de sol·licitud per enviar-la.

Hi ha 4 tipus de sol·licituds diferents:

ACONSEGUIR

Una sol·licitud GET és la forma en què sol·liciteu a l'API que respongui amb alguna cosa que té, la majoria de les dades. Podeu demanar informació específica sobre un ítem o un grup d’ítems en funció del punt final i dels paràmetres. És l’equivalent a demanar a Slash que us porti un dels seus ossos o tots els seus ossos.

POST

Una sol·licitud POST és la forma en què indiqueu a l'API que creï alguna cosa nova. Això és similar a demanar a Slash que us dugui a terme un nou forat.

POSAR

Una sol·licitud PUT és com s'indica a l'API que actualitzi alguna cosa que s'havia creat anteriorment. Això és similar a demanar a Slash que aprofundeixi (actualitzi) el forat que va cavar.

ESBORRAR

Una sol·licitud SUPRIMA és la forma en què indiqueu a l'API que suprimeixi alguna cosa que s'havia creat prèviament. Això és similar a demanar a Slash que tapi (esborri) un forat que va excavar prèviament.

Penseu en aquests quatre tipus. Voleu obtenir informació, crear una entrada nova, canviar una entrada existent o suprimir-ne una? Aquesta resposta us indica exactament quin tipus de sol·licitud necessiteu.

Pas 5: entendre els paràmetres

Moltes sol·licituds requereixen paràmetres addicionals. Els paràmetres són els detalls de la vostra sol·licitud. Per exemple, si voleu que Slash us porti totes les boles vermelles, heu d'especificar el color. Si voleu que crei un nou forat, haureu de dir-li on posar-lo i fins a quin punt ha de cavar.

La documentació de l'API a la qual feu referència hauria de tenir una secció anomenada "Paràmetres" o "Opcions" per a cada punt final i tipus de sol·licitud. Presteu atenció a quins paràmetres són necessaris, ja que alguns són opcionals. Si es marca un paràmetre com a opcional, els documents poden proporcionar un exemple que també sigui el predeterminat.

Els paràmetres de l'API de Slash poden semblar així per recuperar boles:

OBTÉ

Pas 6: formateu la vostra sol·licitud

Tenim tota la informació que necessitem, ara només hem de fer la sol·licitud.

Aquí teniu dues maneres diferents de connectar-vos a una API que no requereix cap codi. Connectem-nos a l'API de Slash per obtenir la seva llista de boles fent una sol·licitud GET a

Paràbola: si voleu connectar-vos i treballar amb dades sense codi

Parabola és una aplicació web que us permet connectar-vos fàcilment a les API i després treballar amb les dades mitjançant una eina visual, arrossegar i deixar anar.