API ഡോക്യുമെന്റേഷൻ

ലഭ്യമായ API എൻഡ്പോയിന്റുകൾക്കുള്ള ഡോക്യുമെന്റേഷൻ ഇതാണ്, അവ REST ആർക്കിടെക്ചർ അടിസ്ഥാനമാക്കിയുള്ളതാണ്. എല്ലാ API എൻഡ്പോയിന്റുകളും JSON പ്രതികരണം തിരികെ നൽകും, സാധാരണ HTTP പ്രതികരണ കോഡുകൾ ഉപയോഗിച്ച്, ഒപ്പം ഒരു API കീ വഴിയുള്ള ബിയറർ ഓഥന്റികേഷൻ ആവശ്യമാണ്.

അധികൃതീകരണം

എല്ലാ API എൻഡ്പോയിന്റുകൾക്കും ബെയറർ ഓഥന്റികേഷൻ രീതി വഴി അയച്ച ഒരു API കീ ആവശ്യമാണ്.

curl --request GET \
--url 'https://bitpeak.ru/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
മറ്റൊന്ന് വ്യക്തമാക്കിയിട്ടില്ലെങ്കിൽ, എല്ലാ API എൻഡ്പോയിന്റ് ഫലങ്ങളും UTC സമയമേഖല പ്രകാരം പ്രവർത്തിക്കുന്നു.
ഉപയോക്താവ്
കാമ്പെയ്‌നുകൾ
കാമ്പെയ്ൻ അറിയിപ്പുകൾ
അറിയിപ്പ് ഹാൻഡ്ലറുകൾ
ടീമുകൾ
ടീം അംഗങ്ങൾ
ടീമുകളുടെ അംഗം
അക്കൗണ്ട് ലോഗുകൾ