Method | URL | Content Type |
---|---|---|
POST | auth/api | application/json |
Description
- This is a token generation method that must be used to make requests to API methods. When called by the client, this method provides a valid access token.
- The validity period of the generated token is set to 8 hours. In other words, a token can be used for 8 hours after it is created.
- In case a token expires, it is necessary to use this method again to obtain a new token to access API methods. This is intended to ensure security and guarantee continuous access.
Required Parameters
Parameter | Type | Required | Description |
---|---|---|---|
username | string | yes | API Username |
password | string | yes | API Password |
Sample Requests
<?php
$data = array(
'username' => "__USERNAME__",
'password' => "__PASSWORD__",
);
$payload = json_encode($data);
$ch = curl_init('__APIURL__/auth/api');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array(
'Content-Type : application/json',
));
$result = curl_exec($ch);
curl_close($ch);
print_r($result);
?>
Sample Responses
{
"token_type": "Bearer",
"expires_in": 86400,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5ODQzOTdhNS0wOTUxLTQyNDEtYmQzZC1iMDE5NmVhMjk5MjgiLCJqdGkiOiIyNDIzMTgwZDJmOWUzNTRlYzU4Njc3MDk1YzExOWNjOWFhOWQxNTkwMDAzZWMwMTQ3OGFhZTUxNjdhZGM4M2VhNDM4NzQzNzVkN2RjN2Y2ZCIsImlhdCI6MTY4NDc2MzQ2NC41ODQ5MTMsIm5iZiI6MTY4NDc2MzQ2NC41ODQ5MTUsImV4cCI6MTY4NDg0OTg2NC41Njg0OTYsInN1YiI6IjE2Iiwic2NvcGVzIjpbXX0.Dv5w1HYSpTCHi15fAWiLqyLjO8PgxOaOsnOMrKM9QT9ELyOMVCwk48OKHTHijzcOapvOfb4ta24pDOZK29_pIuNsQWuG66jcHZ5B8_pDlPEYGAUK4osC8_hHUQXRtw0cfng8cnhbi-5rSkwxPMWWX_ye2bLKBg7ocwSshzvAYfb84NkIJtH-RRr6cdOtip1rv8o82xyP0Nzt5RO9xJi41-3GKEY9PHi-6NqHAFxpzAUnFVOdLh6FZxMXp9yylX5V3rT5wB_l2UUyX015ZqP8B5U0ZF8KWI4XXSpu9h_MRhAxhg-HNUQdpvOF-5lk91jxo7xaaxq3QuFZKozonl5CsQQLUU-zbKR7heLYTvJwra-7QF_bpNnpogrF0zRZ1CV5GjlBOqX80C6vvgkWJ0_Y2fPDftszuKwp-y1zUS-QKpGF5Es5bQX4j_j2f3VIdrSkYja_GdvJzG7rwvjHyW3XJ5eD4pRvHtwdZt8cSdhC4Uyz0xbjCvFlW7Fs866RU8Ac4Na34Nf_kE0LgxNXsjKDuITSetNyeu-pv0NJEU45wBegiVJe8KGXlTyLHX9i7IjeuWhywDwCaleEyaoRaXBowTM0vaoEXaQmoQb8rVM8IzzXZXBZtVWSPZeCZMnFY5jT8bxf7E2js0BYbbdnYrE1pZgJKby4CS6Mnxp6HQ-ErkY",
"refresh_token": "def50200ba8e9cbff8bae111bbab9a82645a83abe916cbbb5c56192d9494e31b4c53eb6bae2c461c7bcc7e4babd56a1a5dad0afbc4d9dec8b7a0761328ffc6c2e115e8a2e9b038428cebaa47dc659103259f05178b6a526ab4bf9e4c36e4308a8ef48fae9c23e895780e63946efd8170a5c236ed0e0268b908ed635a14c786f684c758ed9b8aeb11648fb51673ca2f3d3a8d670c3faf0137ec91146fff2f6754d945cde1e786030764c72d5712cdc3bc33928bc34c8da8cdcce2862db5725afc39b25b3f90169bd15582697a622eca53a3249f24f0c47fba6e745d0f54bd2ec055edde8301adda2088c94868bd705a301b41374e92e6070fca87b65cba2646bb4c344005524ab802dbb2b6b29791ae8e180a251ab75fab3a7205d1109d371718dba3884c54c06a3551ba8dca414cd4b99c3dbeb17f72d78b407cb701a422dd2cef6e0b9131e0372cf1c16ce749e0cdd88b727f9cd8da7622fcd01f027dc244389223959b9014d7c41ea7a8b28b50baabae99bbab80e77c1ff971bdf36deaef1b8550bcba91"
}