Payload

API Payload sú údaje, ktoré chcete preniesť na server, keď zadáte požiadavku na rozhranie API. Jednoducho povedané, je to telo vašej HTTP požiadavky (správa).

 

Pre lepšie pochopenie si predstavte odoslanie správy ”Ahoj”, ktorú označíme ”msg” (skratka pre správu). ”Ahoj” môžeme považovať za Payload a ”msg” štítok, pod ktorým sa táto informácia presúva. Keď sú telo aj značka odoslané, jediným viditeľným údajom je ”Ahoj”. Označenie „msg“ sa používa iba na interné účely na identifikáciu vašich údajov.

Takýto payload možno cez API odosielať alebo prijímať v rôznych formátoch, ako sú JSON alebo XML. V reťazci dopytu možno túto časť identifikovať pomocou zložených zátvoriek „{}“, napr.:

Endpoint: POST /statuses/update
Payload:
{
„status“: „Hello, Twitter! This is a test tweet from my API client. #API“
}