À propos de Web API

Web API est un cadre utilisé pour créer un service HTTP qui atteint une grand diversité de clients, y compris les dispositifs de navigation et mobiles.

URL de base

Voici l'URL de base :

<Protocole>://<Nom du domaine>:<Numéro de port>/api/v1

Connexion

Saisissez le nom d'utilisateur et le mot de passe pour obtenir le jeton. Lors de l'utilisation de la sécurité, le jeton est utilisé pour l'autorisation.

Remarque : l'authentification basée sur un jeton est une technique de sécurité qui permet d'authentifier les utilisateurs qui tentent de se connecter à un serveur, un réseau ou un autre système sécuritaire à l'aide d'un jeton de sécurité fourni par le serveur.

Vue d'ensemble

Demande

Élément Valeur
MéthodePOST
URL<Base URL>/login
ParamètresN/A
En-tête Contenu-Type, Contenu-Longueur
En-tête Valeur
Content-Type application/json
Corps JSON
Champ Type de données Remarques
usernamestring Nom d'utilisateur
passwordstring Password
Exemple

POST http://192.168.1.100:8000/api/v1/login HTTP/1.1

Host: localhost:8082

Content-Type: application/json

content-length: 44

{

"username":"User1",

"password":"Pass1"

}

Remarque : l'exemple de code est écrit en Java.

Réponse

Élément Valeur
Code d'état Authentification réussie, l'afficheur enverra 200 (OK).
Code Notes
200 OKAuthentification réussie
401 UnauthorizedAuthentification échouée
En-tête Contenu-Type, Transfert-Encodage
En-tête Valeur
Content-Type application/json
Transfer-Encoding Chunked
Corps JSON
Champ Type de données Notes
token string Jeton authentifié
Exemple

 

0

Remarque : l'exemple de code est écrit en Java.