Créer un token
Les tokens API sont une bonne façon de s'authentifier à notre API tout en se séparant de son nom d'utilisateur et mot de passe. Nous vous recommandons fortement de les utiliser. Vous trouverez ici comment gérer vos tokens. Vous pouvez créer un token avec notre API ou sur notre plateforme.
Afin de créer votre premier token, vous devez aller sur notre plateforme
POST
/token
Paramètres du body
name
requis
|
Le nom du token |
ttl | Le TTL en seconde. Par défaut pas d'expiration |
allowed_ips | Gérer les adresses IP autorisées à faire une demande avec ce token (IPv4, IPv6 et cidr sont compatibles) |
Exemples
POST /token HTTP/1.1
Host: api.smsfactor.com
Authorization: Bearer your.token
Accept: application/json
{
"token":{
"name": "Best token ever",
"ttl": 2678400,
"allowed_ips": [
"2a01:cb1d:2b9:ef02:2521:4ed1:109a:8fae",
"192.168.2.0/24",
"192.168.2.2"
]
}
}
POST /token HTTP/1.1
Host: api.smsfactor.com
Authorization: Bearer your.token
Accept: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<token>
<name>Best token ever</name>
<ttl>2678400</ttl>
</token>
$response = \SMSFactor\Token::create([
'token' => [
'name' => 'Best token ever',
"ttl" => 2678400,
"allowed_ips": [
"2a01:cb1d:2b9:ef02:2521:4ed1:109a:8fae",
"192.168.2.0/24",
"192.168.2.2"
]
]
]);
$token = $response->token;
$token_id = $response->token_id;
Format de la réponse
Une fois le token créé, vous ne pourrez plus le récupérer. Pensez à le sauvegarder.
{
"status": 1,
"message": "OK",
"token": "yJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMTY1NiIsImlhdCI6MTUxOTEyMDg2NX0.ZnGgbDC0OI3hPm2UXyl4rxU9JlpMTMBcTJT8RVgJbtQ",
"token_id": "2",
"allowed_ips": [
"2a01:cb1d:2b9:ef02:2521:4ed1:109a:8fae",
"192.168.2.0/24",
"192.168.2.2"
]
}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>1</status>
<message>OK</message>
<token>yJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMTY1NiIsImlhdCI6MTUxOTEyMDg2NX0.ZnGgbDC0OI3hPm2UXyl4rxU9JlpMTMBcTJT8RVgJbtQ</token>
<token_id>2</token_id>
</response>