Ne všichni děláme integrace každý den. Proto jsme pro vás připravili rychlokurz integrace v dnešním světě, kde stručně zmiňujeme ty nejdůležitější pojmy a nástroje. Až se všim prokousáte, můžete pokračovat na příklady volání Not all of us are involved in integration every day. That is why we have prepared a crash course in integration in today’s world for you, in which we briefly mention the most important terms and tools. After having chewed it all over, you can continue on examples of calling API.
Základní principy a pojmy
Co potřebuje mít člověk v hlavě, aby rozuměl věcem kolem API
...
Basic principles and terms
Everything you need to know to understand the ins and outs of API
Communication over the Internet https://everything.curl.dev/protocols/network
Internetové protokoly Internet protocols https://everything.curl.dev/protocols/protocols
EndPoint - https://en.wikipedia.org/wiki/Web_API
REST- https://en.wikipedia.org/wiki/Representational_state_transfer https://zdrojak.cz/clanky/rest-architektura-pro-webove-api/
Curl
Curl je open source program pro přenos dat přes různé internetové protokoly. Jeho příkazy se používají k popisu toho, jak se jaká data se při integraci přenáší. Stejně tak lze příkazy v programu spustitis an open source program for data transfer through different Internet protocols. Its commands are used to describe how what sort of data are transferred during integration. Commands can be run in the program in the same way.
HTTP POST https://everything.curl.dev/http/post
HTTP Multipart formposts https://everything.curl.dev/http/multipart
HTTP cheat sheet - https://everything.curl.dev/http/cheatsheet
Seznam všech příkazů List of all commands - https://curl.se/docs/manpage.html
curl HTTP cheat sheet:
hide progress -s | verbose -v --trace-ascii <file> | extra info -w "format" | output -O -o <file> | timeout -m <seconds> |
POST -d "string" -d @file | POST encoded --data-urlencode "[name]=val" | multipart formpost -F name=value -F name=@file | PUT -T <file> | HEAD (ers too) -I -i |
custom method -X "METHOD" | read cookiejar -b <file> | write cookiejar -c <file> | send cookies -b "c=1; d=2" | user-agent -A "string" |
proxy -x <host:port> | add/remove headers -H "name: value" -H "name:" | custom address --resolve <host:port:addr> | smaller data --compressed | insecure HTTPS -k |
Basic auth -u user:passwd | follow redirects -L | parallel -Z | generate code --libcurl <file> | list options --help |
ZdrojSource: https://curl.github.io/curl-cheat-sheet/http-sheet.html
Seznam všech příkazůList of all commands: https://curl.se/docs/manpage.html
Curl je většinou již součástí operačního systému - např. MS Windows, kde se spouští z aplikace Příkazová řádka, jež se spouští vyhledáním “cmd” ve vyhledávacím poli na pracovní ploše.
...
Curl příkaz spuštěný z příkazové řádky na MS Windows a jeho výsledek
Apiary
Apiary je jedna ze služeb sloužících pro zveřejňování dokumentace API. Využívá ji i Signi na https://signiis generally already a component part of the operating system - for example MS Windows - where it is launched from the Command line application, which is run by searching for “cmd” in the search box on the desktop.
...
Curl command launched from the command line in MS Windows and its outcome
Apiary
Apiary is one of the services used to make API documentation public. Signi also uses it at https://signien.docs.apiary.io/
...
Příklad popisu endpointu “Autorizace Example of description of endpoint “Authorization > x-api-key > Detail uživatele”User detail”,
při volbě cURL v pravém panelu je vidět sada příkaz curl, stejně tak je možné zvolit jiná prostředí
Postman
...
when selecting cURL in the right-hand panel, a set of curl commands can be seen;
even then it is possible to choose a different environment
Postman
Postman is one of the services used for testing API calling. Signi also uses it at https://signiapi.postman.co/.
...
Příklad volání endpointu Detail uživateleExample of calling endpoint User detail