Skip to content

API Documentation

Willy edited this page May 4, 2018 · 1 revision

Service Listen Port: 8082

Eureka Registration ID: AGENTS_SERVICE

Endpoints

/auth

Auth endpoint helps to check if an agent is authorized or not to login in the system.

POST

Value Type Example
login String Pepe
password String pepepassword
kind int 1

Return: OK / UNAUTHORIZED

In case and OK response is generated a body with all the agent data is generated and provided. Here is how it looks.

{
 "kindCode":1,
 "kind":"Person",
 "name":"Clara Oswin Oswald",
 "location":"10N10W",
 "id":"45170000A",
 "email":"[email protected]"
}

/info

Auth endpoint helps to register an agent in the system.

GET

{"service-name":"agents_service","service-description":""}

/register

This endpoint helps to register an agent in the system.

POST

Value Type Example
name String Pepe
location String 10N10W
email String [email protected]
password String 1234
username String 4517000X
kindCode int 1

Return: CREATED / BAD_REQUEST

Clone this wiki locally