15 otázek, které byste se měli zeptat na jejich API před výběrem platformy

Dobrý přítel a rádce, který napsal, mi položil otázku a rád bych použil své odpovědi pro tento příspěvek. Jeho otázky byly trochu více zaměřeny na jedno odvětví (e-mail), takže jsem zobecnil své odpovědi na všechna API. Před výběrem se zeptal, jaké otázky by se měla společnost zeptat dodavatele na jejich API.

Proč potřebujete API?

An aplikační programovací rozhraní (API) je rozhraní, které poskytuje počítačový systém, knihovna nebo aplikace za účelem umožnění požadavků na služby, které z něj mohou provádět jiné počítačové programy, a / nebo umožnění výměny dat mezi nimi.

Wikipedia

Stejně jako zadáte adresu URL a získáte odpověď zpět na webové stránce, API je metoda, kde vaše systémy mohou požadovat a získat odpověď zpět k synchronizaci dat mezi nimi. Jelikož se společnosti chtějí digitálně transformovat, automatizace úkolů prostřednictvím API je skvělý způsob, jak zlepšit efektivitu v organizaci a snížit lidské chyby.

API jsou ústředním prvkem automatizace, zejména v marketingových aplikacích. Jednou z výzev při nakupování u velkého prodejce s komplexem API je, že zdroje a výdaje na vývoj jsou obvykle dodatečnou myšlenkou. Marketingový tým nebo CMO může řídit nákup aplikace a někdy vývojový tým nezíská mnoho informací.

Výzkum možností integrace platformy pomocí API vyžaduje více než jednoduchou otázku, Existuje API? A další otázka:

Jaké typy rozhraní API existují?

Existuje mnoho různých typů technologií API, z nichž každá má své vlastní specifické funkce a případy použití. Typ technologie API, která je pro vaši aplikaci nejlepší, bude záviset na vašich konkrétních potřebách a požadavcích. Zde je 6 běžných typů technologií API:

1. REST API - REST Rozhraní API jsou typem webového rozhraní API, které používá metody HTTP (například GET, POST, PUT a DELETE) k načítání a manipulaci s daty. REST API jsou navržena tak, aby byla lehká a flexibilní a často se používají pro vytváření webových a mobilních aplikací.
2. SOAP API - MÝDLO (Simple Object Access Protocol) API jsou typem webového API, které používá XML (Extensible Markup Language) ke kódování dat a jejich přenosu přes HTTP. SOAP API jsou standardizovanější a strukturovanější než REST API a často se používají v podnikových prostředích, kde je důležitá bezpečnost a spolehlivost.
3. GraphQL API – GraphQL je dotazovací jazyk pro rozhraní API, který umožňuje vývojářům požadovat konkrétní data z rozhraní API namísto přijímání pevné sady dat. Rozhraní API GraphQL jsou flexibilní a umožňují vývojářům požadovat pouze data, která potřebují, což může zlepšit výkon a snížit plýtvání daty.
4. Webhooks – Webhooky jsou typem technologie API, která umožňuje serveru odesílat data klientovi v reálném čase, místo aby klient musel vyžadovat data ze serveru. Webhooky se často používají k umožnění komunikace mezi aplikacemi v reálném čase a ke spouštění akcí, když nastanou určité události.
5. Cloud API – Cloudová rozhraní API umožňují vývojářům přístup a interakci se službami cloud computingu, jako jsou úložiště, databáze a analýzy. Tato rozhraní API mohou pomoci vývojářům vytvářet a nasazovat aplikace efektivněji a efektivněji.
6. Hardwarová rozhraní API – Hardwarová rozhraní API umožňují vývojářům přistupovat a ovládat hardwarová zařízení, jako jsou senzory, kamery a tiskárny. Tato rozhraní API lze použít k vytváření aplikací, které komunikují s fyzickými zařízeními a ovládají je.

Pokud se přihlásíte pomocí aplikace se špatně podporovaným nebo zdokumentovaným rozhraním API, poblázníte svůj vývojový tým a vaše integrace pravděpodobně přijdou krátce nebo selžou úplně. Najděte správného dodavatele a vaše integrace bude fungovat a vaši vývojoví pracovníci vám rádi pomohou!

Výzkumné otázky týkající se jejich schopností API:

1. Funkce Gap - Určete, jaké funkce jejich uživatelského rozhraní jsou k dispozici prostřednictvím rozhraní pro programování aplikací. Jaké funkce má rozhraní API, které uživatelské rozhraní nemá a naopak?
2. Měřítko - Zeptejte se, kolik hovorů je na jejich API denně. Mají vyhrazenou skupinu serverů? Kvantita je neuvěřitelně důležitá, protože chcete zjistit, zda je API doplňkem nebo skutečně součástí strategie společnosti.
3. Dokumentace - Požádejte o dokumentaci API. Mělo by to být robustní, vysvětlovat všechny funkce a proměnné dostupné v API.
4. Komunita - Zeptejte se, zda mají k dispozici online komunitu vývojářů pro sdílení kódu a nápadů s dalšími vývojáři. Komunity vývojářů jsou klíčem k rychlému a efektivnímu zahájení vývoje a integrace. Spíše než využívat „chlápka API“ ve společnosti, využíváte také všechny jejich zákazníky, kteří již měli při integraci svých řešení pokusy a chyby.
5. Typy API – Znalost typu API, které používáte, integrace mohou být docela snadné. Opak je však pravdou, pokud nejste obeznámeni s funkcemi a požadavky na používání API.
6. Jazyky - Zeptejte se, s jakými platformami a aplikacemi se úspěšně integrovali, a vyžádejte si kontakty, abyste od těchto zákazníků zjistili, jak obtížná byla integrace a jak dobře funguje API.
7. Omezení - Zeptejte se, jaká omezení má prodejce v počtu hovorů za hodinu, za den, za týden atd. Pokud nejste u škálovatelného prodejce, bude váš růst omezen zákazníkem.
8. Vzorky - Nabízejí knihovnu příkladů kódu, která vám usnadní začátek? Mnoho společností publikuje SDK (Software Development Kits) pro různé jazyky a rámce, které urychlí vaši časovou osu integrace.
9. pískoviště - Nabízejí neprodukční koncový bod nebo prostředí izolovaného prostoru, kde můžete svůj kód otestovat?
10. Zdroje - Zeptejte se, jestli mají v rámci své společnosti vyhrazené zdroje pro integraci. Mají pro integraci k dispozici interní poradenskou skupinu? Pokud ano, vhoďte do smlouvy několik hodin!
11. Zabezpečení - Jak se ověřují pomocí API? Jsou to pověření uživatele, klíče nebo jiné metodiky? Mohou omezit požadavky podle IP adresy?
12. Uptime - Zeptejte se, jaké jsou API provozuschopnost a chybovost jsou a kdy jsou jejich hodiny údržby. Důležité jsou také strategie, jak je obejít. Mají interní procesy, které se znovu pokusí API volání v případě, že záznam není k dispozici kvůli jinému procesu? Je to něco, co ve svém řešení vytvořili?
13. SLA - Mají Service Level Agreement kde by doba provozu měla být vyšší než 99.9%?
14. plán - Jaké budoucí funkce začleňují do svého API a jaké jsou očekávané plány dodání?
15. integrace - Jaké produktivní integrace vyvinuli nebo které vyvinuli třetí strany? Někdy se společnosti mohou vzdát interního vývoje funkcí, když již existuje další produktivní integrace a je podporována.

Klíčem k těmto otázkám je to, že vás integrace „vdá“ do platformy. Nechcete si někoho vzít, aniž byste o něm věděli co nejvíce, že? To je přesně to, co se stane, když si lidé koupí platformu bez znalosti jejích integračních schopností.

Kromě rozhraní API byste se měli také pokusit zjistit, jaké další integrační zdroje mohou mít: čárové kódy, mapování, služby čištění dat, RSS, webové formuláře, widgety, formální integrace partnerů, skriptovací motory, SFTP kapky atd.