API's - Enterprise Service Platform
Esta seção destina-se a descrever a estrutura de comunicação REST, estabelecida entre aplicativos e o servidor de back-end.
⚠️Atenção!
4biz_URL: prefixo de URL inalterável, para que você possa acessar os serviços disponibilizados para os aplicativos móveis. Todo API que necessita um "sessionID" precisará estar em uma sessão forneceida pelo "Login" da API.
Login
Login do usuário para usar os Serviços 4biz:
POSTResponse {
"sessionID": "2355A68BF75281B73607EEC1A7191645",
"rangeAction": 10,
"locationInterval": 10
}ListContracts
Lista dos contratos acessíveis ao atendente.
POST {
"dateTime": 1412101947000,
"operationID": 65,
"error": null,
"contracts": [
{
"id": 1,
"description": "Test Name"
}
]
}ListDeniedReasons
Lista de razões quando recusar uma solicitação, como no check-in:
POST {
"dateTime": 1412101988000,
"operationID": 666,
"error": null,
"reasons": [
{
"id": 1,
"description": "First Suspension Reason"
},
{
"id": 2,
"description": "Second Suspension Reason"
}
]
}ListSolicitationStatus
Lista os status de uma solicitação a ser usada, por exemplo, no serviço de checkout.
POST {
"dateTime": 1412101662000,
"operationID": 64,
"error": null,
"status": [
{
"id": 1,
"description": "In progress"
},
{
"id": 2,
"description": "Suspended",
"justifications": [
{
"id": 1,
"description": "First Suspension Reason"
},
{
"id": 2,
"description": "Second Suspension Reason"
}
]
},
{
"id": 3,
"description": "Canceled"
},
{
"id": 4,
"description": "Solved",
"justifications": [
{
"id": 1,
"description": "Reconfigured database user",
"parentId": null
},
{
"id": 2,
"description": "Any other solution here",
"parentId": 1
}
]
}
]
}ListUnits
Lista as unidades de um contrato:
POST {
"dateTime": 1412101988000,
"operationID": 66,
"error": null,
"units": [
{
"id": 1,
"description": "Default"
},
{
"id": 2,
"description": "Unit Test"
}
]
}
SendCoordinates
Atualiza as coordenadas geográficas de uma unidade.
POST {
"dateTime": 1412102841000,
"operationID": 68,
"error": null,
"success": true
}
DeviceDisassociate
Desassociar um usuário de um dispositivo para que, quando um usuário excluir uma conexão, o usuário não receba mais a notificação push da conexão excluída.
POST {
"dateTime": 1412102841000,
"operationID": 68,
"error": null,
"success": true
}
GetNewest
Recupera a solicitação mais recente para o usuário no grupo, a partir da última (newestNumber) no aplicativo.
POST {
"dateTime": 1377618318000,
"operationID": 336,
"error": null,
"notifications": [
{
"number": 95933,
"taskId": 22737,
"type": 1,
"date": "27/08/2013",
"timeFlag": 12345,
"timeSLA": 12,
"latitude": 32.9984730,
"longitude": 29.9984730,
"endSLA": "null",
"task": "Validar requisição",
"personal": true,
"inService": true,
"inCkeckin": 0,
"typeRequest": 0,
"waiting": 1,
"service": "SERVICES AND PRODUCTS REQUEST",
"contract": 1,
"unit": 15,
"priorityorder": 1
}
]
}GetOldest
Recupere a solicitação mais recente para o usuário no grupo, do mais antigo.
POST {
"dateTime": 1377618318000,
"operationID": 336,
"error": null,
"notifications": [
{
"number": 95933,
"taskId": 22737,
"type": 1,
"date": "27/08/2013",
"timeFlag": 12345,
"timeSLA": 12,
"latitude": 32.9984730,
"longitude": 29.9984730,
"endSLA": "null",
"task": "Validate request",
"personal": true,
"inService": true,
"inCheckin": 1,
"typeRequest": 0,
"waiting": 1
"service": "SERVICES AND PRODUCTS REQUEST",
"contract": 1,
"unit": 15,
"priorityorder": 1
}
]
}GetByCoordinates
Recupera a solicitação mais recente para o usuário no grupo, a partir das coordenadas atuais do usuário.
POST {
"dateTime": 1377618318000,
"operationID": 336,
"error": null,
"notifications": [
{
"number": 95933,
"taskId": 22737,
"type": 1,
"date": "27/08/2013",
"timeFlag": 12345,
"timeSLA": 12,
"latitude": 32.9984730,
"longitude": 29.9984730,
"endSLA": "null",
"task": "Validate request",
"typeRequest": 0,
"waiting": 1
"personal": true,
"inService": true,
"inCheckin": 1,
"service": "SERVICES AND PRODUCTS REQUEST",
"contract": 1,
"unit": 15,
"priorityorder": 1
}
],
"paging": {
"page": 1,
"size": 1,
"totalElements": 5,
"totalPages": 5
}
}UpdateNotification
Recupera as tarefas de um serviço.
POST {
"dateTime": 1377618318000,
"operationID": 336,
"error": null,
"notifications": [
{
"number": 95933,
"taskId": 22737,
"type": 1,
"date": "27/08/2013",
"timeFlag": 12345,
"timeSLA": 12,
"latitude": 32.9984730,
"longitude": 29.9984730,
"endSLA": "null",
"task": "Validate request",
"personal": true,
"inService": true,
"inCheckin": 1,
"typeRequest": 0,
"waiting": 1
"service: "SERVICES AND PRODUCTS REQUEST",
"contract": 1,
"unit": 15,
"priorityorder": 1
}
]
}GetById
Recupera detalhes de uma solicitação, de acordo com seu identificador
POST {
"dateTime": 1377618392000,
"operationID": 337,
"error": null,
"notification": {
"endSLA": "null",
"task": "Validate request",
"service": "SERVICES AND PRODUCTS REQUEST",
"description": " test",
"status": "In progress",
"taskStatus": "Available",
"timeSLA": 12
}
}
GetReasons
Recuperar os motivos a serem utilizados na aprovação de uma solicitação, de acordo com a solicitação.
POST {
"dateTime": 1377618482000,
"operationID": 339,
"error": null,
"amount": 4,
"reasons": [
{
"id": 1,
"desc": "Non-refundable authorization"
},
{
"id": 4,
"desc": "Purchase necessary to the business"
},
{
"id": 6,
"desc": "Purchase need supplied with another solution"
},
{
"id": 5,
"desc": "Value of quotation above the budget of the contract"
}
]
}AttendRequest
Informar o início do atendimento de uma solicitação de serviço.
POST {
"dateTime": 1377618517000,
"operationID": 341,
"error": null,
"success": true
}
AttendantLocation
Informa a localização automática da posição do atendente.
POST {
"dateTime": 1412102841000,
"operationID": 68,
"error": null,
"success": true
}
Feedback
Registra uma aprovação ou negação de uma solicitação de serviço.
POST {
"dateTime": 1377618517000,
"operationID": 341,
"error": null
}New
Cria uma nova solicitação.
POST {
"dateTime": 1377618543000,
"operationID": 342,
"error": null,
"number": 95935
}Check-In
Check-in do atendente em uma solicitação. Em outras palavras, inicia o cumprimento da solicitação.
POST {
"dateTime": 1377618543000,
"operationID": 342,
"error": null,
"number": 95935
}Check-Out
Verifica um atendente em uma solicitação, atualizando seu status ("Suspenso", "Resolvido", etc.).
POST {
"dateTime": 1377618517000,
"operationID": 342,
"error": null,
"number": 95935
}Check-InDenied
Registrar a negação de uma solicitação de atendimento pelo atendente, nos casos de recusa ao check-in.
POST {
"dateTime": 1377618543000,
"operationID": 342,
"error": null
}