15 vrae wat u moet vra oor hul API voordat u 'n platform kies

'N Goeie vriend en mentor het 'n vraag aan my gestel en ek wil graag my antwoorde vir hierdie pos gebruik. Sy vrae was 'n bietjie meer gerig op een bedryf (e-pos), so ek het my antwoorde op alle API's veralgemeen. Hy het gevra watter vrae 'n onderneming aan 'n verkoper oor hul API moet stel voordat hy 'n keuse maak.

Waarom benodig u API's?

An toepassingsprogrammeringskoppelvlak (API) is die koppelvlak wat 'n rekenaarstelsel, -biblioteek of -toepassing bied om versoeke vir dienste deur ander rekenaarprogramme daaraan te maak, en / of om data tussen hulle uit te ruil.

Wikipedia

Net soos u 'n URL intik en 'n antwoord op 'n webblad terugkry, is 'n API 'n metode waar u stelsels kan aanvra en terugvoer kry om data tussen hulle te sinchroniseer. Aangesien ondernemings hulself digitaal wil transformeer, is die automatisering van take deur middel van API's 'n uitstekende manier om doeltreffendheid binne die organisasie te verbeter en menslike foute te verminder.

API's is sentraal tot outomatisering, veral in bemarkingstoepassings. Een van die uitdagings as u 'n uitstekende handelaar met 'n uitgebreide winkel koop API is dat hulpbronne en uitgawes vir ontwikkeling gewoonlik 'n nadink is. Die bemarkingspan of CMO kan die aankoop van 'n aansoek beywer en soms kry die ontwikkelingspan nie veel insette nie.

Om die integrasie van 'n platform via 'n API te ondersoek, vereis meer as die eenvoudige vraag, Is daar 'n API? En die volgende vraag:

Watter tipe API's is daar?

Daar is baie verskillende tipes API-tegnologieë, elk met sy eie spesifieke kenmerke en gebruiksgevalle. Die tipe API-tegnologie wat die beste vir jou toepassing is, sal afhang van jou spesifieke behoeftes en vereistes. Hier is 6 algemene tipes API-tegnologieë:

1. REST API's - REST API's is 'n tipe web-API wat HTTP-metodes (soos GET, POST, PUT en DELETE) gebruik om data te herwin en te manipuleer. REST API's is ontwerp om liggewig en buigsaam te wees, en word dikwels gebruik vir die bou van web- en mobiele toepassings.
2. SOAP API's - SOAP (Simple Object Access Protocol) API's is 'n tipe web-API wat XML (Extensible Markup Language) gebruik om data te enkodeer en oor HTTP te versend. SOAP API's is meer gestandaardiseer en gestruktureer as REST API's, en word dikwels in ondernemingsomgewings gebruik waar sekuriteit en betroubaarheid belangrik is.
3. GraphQL API's - GraphQL is 'n navraagtaal vir API's wat ontwikkelaars toelaat om spesifieke data van 'n API aan te vra eerder as om 'n vaste stel data te ontvang. GraphQL API's is buigsaam en laat ontwikkelaars toe om slegs die data aan te vra wat hulle benodig, wat werkverrigting kan verbeter en datavermorsing kan verminder.
4. webhooks – Webhooks is 'n tipe API-tegnologie wat 'n bediener toelaat om data intyds na 'n kliënt te stuur, eerder as dat die kliënt data van die bediener moet aanvra. Webhooks word dikwels gebruik om intydse kommunikasie tussen toepassings moontlik te maak en om aksies te aktiveer wanneer sekere gebeurtenisse plaasvind.
5. Wolk API's – Wolk-API's laat ontwikkelaars toe om toegang tot wolkrekenaardienste, soos berging, databasisse en analise, te verkry en daarmee interaksie te hê. Hierdie API's kan ontwikkelaars help om toepassings meer doeltreffend en doeltreffend te bou en te ontplooi.
6. Hardeware API's – Hardeware-API's laat ontwikkelaars toe om toegang tot hardeware-toestelle, soos sensors, kameras en drukkers, te verkry en te beheer. Hierdie API's kan gebruik word om toepassings te bou wat interaksie met en fisiese toestelle beheer.

As u aanmeld met 'n toepassing met 'n swak ondersteunde of gedokumenteerde API, sal u u ontwikkelingspan gek maak en sal u integrasies waarskynlik te kort kom of heeltemal misluk. Soek die regte verskaffer, en u integrasie sal werk en u ontwikkelingsmense sal u graag help!

Navorsingsvrae oor hul API-vermoëns:

1. Gaping van funksies - Identifiseer watter funksies van hul gebruikerskoppelvlak beskikbaar is via die toepassingsprogrammeringskoppelvlak. Watter funksies het die API wat die UI nie het nie en andersom?
2. Skaal - Vra hoeveel oproepe na hulle geskakel word API daagliks. Het hulle 'n toegewyde poel bedieners? Hoeveelheid is ongelooflik belangrik, aangesien u wil identifiseer of die API 'n nabetragting is of eintlik deel uitmaak van die onderneming se strategie.
3. dokumentasie - Vra vir die API-dokumentasie. Dit moet robuust wees en elke funksie en veranderlike in die API beskikbaar stel.
4. Gemeenskap - Vra of hulle 'n aanlyn ontwikkelaarsgemeenskap beskikbaar het om kode en idees met ander ontwikkelaars te deel. Ontwikkelingsgemeenskappe is die sleutel om u ontwikkelings- en integrasiepogings vinnig en doeltreffend te loods. In plaas daarvan om 'die API-man' by die maatskappy te benut, gebruik u ook al hul klante wat alreeds proewe en foute gehad het om hul oplossing te integreer.
5. Tipes API - As u vertroud is met die tipe API wat u gebruik, kan integrasies redelik maklik wees. Die teenoorgestelde is egter waar as u nie vertroud is met die kenmerke en vereistes om 'n API te gebruik nie.
6. Tale - Vra met watter platforms en toepassings hulle suksesvol geïntegreer is, en versoek kontak, sodat u by die klante kan uitvind hoe moeilik dit was om te integreer en hoe goed die API werk.
7. Beperkings - Vra watter beperkings die verkoper het in aantal oproepe per uur, per dag, per week, ens. As u nie by 'n skaalbare verkoper is nie, sal u groei beperk word deur die klant.
8. Monsters - Bied hulle 'n biblioteek met kode-voorbeelde aan om maklik te begin? Baie maatskappye publiseer SDK (sagteware-ontwikkelingskits) vir verskillende tale en raamwerke wat u integrasietydlyn sal versnel.
9. sandbox - Bied u 'n nie-produksie-eindpunt of sandbox-omgewing vir u om u kode in te toets?
10. Hulpbronne - Vra of hulle toegewyde integrasiebronne in hul onderneming het. Het hulle 'n interne konsultasiegroep beskikbaar vir integrasie? As dit so is, gooi 'n paar uur in die kontrak!
11. sekuriteit - Hoe verifieer hulle met behulp van die API? Is dit gebruikersbewyse, sleutels of ander metodologieë? Kan hulle versoeke per IP-adres beperk?
12. Uptime - Vra wat van hulle API uptime en foutsyfer is, en wanneer hul onderhoudstyd is. Strategieë om daaromheen te werk is ook belangrik. Het hulle interne prosesse wat weer sal probeer? API oproepe indien die rekord weens 'n ander proses nie beskikbaar is nie? Is dit iets wat hulle in hul oplossing ontwerp het?
13. SLA - Het hulle 'n Diensvlakooreenkoms waar opstye 99.9% moet wees?
14. Padkaart - Watter toekomstige funksies bevat hulle in hul API en wat is die verwagte afleweringskedules?
15. integrasie - Watter geproduktiseerde integrasies het hulle ontwikkel of wat derdepartye ontwikkel het? Soms kan maatskappye die interne ontwikkeling rakende funksies laat vaar wanneer 'n ander geïdentifiseerde integrasie reeds bestaan ​​en ondersteun word.

Die sleutel tot hierdie vrae is dat integrasie jou met die platform 'trou'. Jy wil tog nie met iemand trou sonder om soveel as moontlik van hulle te weet nie, of hoe? Dit is net wat gebeur wanneer mense 'n platform koop sonder kennis van die integrasievermoëns daarvan.

Behalwe 'n API, moet jy ook probeer om uit te vind watter ander integrasiehulpbronne hulle kan hê: Streepkodering, kartering, data skoonmaakdienste, RSS, Webvorms, Widgets, formele vennootintegrasies, Scripting-enjins, SFTP druppels, ens.