Requisição de Código de Autenticação
Sucesso
{
"message": null,
"auth_code": "679664CF3F",
"code": 200
}
Erro
erro: 403
{
"message": "limite de c\u00f3digos atingidos",
"auth_code": null,
"code": 403
}
erro: 404
{
"message": "nenhum c\u00f3digo de cliente encontrado",
"auth_code": null,
"code": 404
}
erro: 500
{
"message": "geração do código de autenticação falhou",
"auth_code": null,
"code": 500
}
|
/api/request-code/{CLIENT_ID} |
CLIENT_ID
Código de autorização do cliente.
Composto de 10 digitos Alfanumérico. Ex: 5745819-11
|
GET |
Cancela um Código de Autenticação
Sucesso
{
"message": null,
"code": 200
}
Erro
erro: 404
{
"message": "nenhum codigo encontrado",
"token": null,
"code": 404
}
erro: 500
{
"message": "revogação do codigo falhou",
"token": null,
"code": 500
}
|
/api/revoke-code/{AUTH_CODE} |
AUTH_CODE
Código de autorização de uma maquina da empresa.
Composto de 10 digitos Alfanumérico. Ex: 1912B5DD69
|
GET |
Reseta Código de Autenticação
Sucesso
{
"code": 200,
"data": {
"config": {
"local_config": false,
"automatic_directory_management": false,
"remove_musics": false,
"remove_medias": false,
"propagate_deletions": false,
"optimize_verifications": true,
"sync_interval": 1,
"partial_sync_interval": 10,
"complete_sync_interval": "04:00",
"check_version_software": "03:00",
"update_products": false,
"has_password": false,
"available_download": true,
"available_upload": false
},
"token": {
"token": "352CA7BF4128254F3933BAF665E23089",
"refresh_token": "DC1861D815E18EF90AD7075B6A8D5B27"
}
}
}
Erro
erro: 500
{
"code": 500,
"message": "target not found"
}
|
/api/reset-auth-code/{AUTH_CODE}/{TARGET} |
AUTH_CODE
Código de autorização de uma maquina da empresa.
Composto de 10 digitos Alfanumérico. Ex: 1912B5DD69
|
TARGET
Alvo do reset do código podendo ser: TOKEN, CONFIG, ALL
TOKEN: reseta os Tokens do código, retornando um novo token e refresh token.
CONFIG: reseta as Configs do código, retornando a config padrão.
ALL: reseta os tokens e config.
|
GET |
Requisição de Token
Sucesso
{
"message": null,
"token": "4FFE2F70B6B915FD1C97B45EE9321377",
"refresh_token": "CE57930462A7CC5553A45B2806CF36B3",
"code": 200
}
Erro
erro: 404
{
"message": "c\u00f3digo de autentica\u00e7\u00e3o inv\u00e1lido",
"token": null,
"code": 404
}
erro: 500
{
"message": "geração do token falhou",
"token": null,
"code": 500
}
|
/api/request-token/{AUTH_CODE} |
AUTH_CODE
Código de autorização de uma maquina da empresa.
Composto de 10 digitos Alfanumérico. Ex: 1912B5DD69
|
GET |
Requesição de Informações da Empresa
Sucesso
{
"message": null,
"data": {
"name": "Atl\u00e2ntida Pelotas"
},
"code": 200
}
Erro
erro: 404
{
"message": "nenhum c\u00f3digo de cliente encontrado",
"data": null,
"code": 404
}
|
/api/request-infos/{CLIENT_ID} |
CLIENT_ID
Código de autorização do cliente.
Composto de 10 digitos Alfanumérico. Ex: 5745819-11
|
GET |
Cadastra Informações
Sucesso
{
"message": null,
"code": 200
}
Erro
erro: 500
{
"message": "falha ao tentar adicionar as informações",
"code": 500
}
|
/api/set-infos/ |
PARÂMETROS POST
client_id - Composto de 10 digitos Alfanumérico. Ex: 5745819-11
auth_code - Composto de 10 digitos Alfanumérico. Ex: 1912B5DD69
nickname Apelido do PC que o Software foi instalado - Alfanumérico
serial_number Serial Number do cadastro do software - Alfanumérico - Tamanho 06 caracteres
version Versão do Software Instalado - Alfanumérico - Ex: 1.1.15
|
POST |
Atualiza Versão
Sucesso
{
"message": null,
"code": 200
}
Erro
erro: 500
{
"message": "falha ao tentar adicionar as informações",
"code": 500
}
|
/api/update-infos/ |
PARÂMETROS POST
client_id - Composto de 10 digitos Alfanumérico. Ex: 5745819-11
auth_code - Composto de 10 digitos Alfanumérico. Ex: 1912B5DD69
version Versão do Software Instalado - Alfanumérico - Ex: 1.1.15
|
POST |
Cancela um Token
Sucesso
{
"message": null,
"token": null,
"code": 200
}
Erro
erro: 404
{
"message": "nenhum token encontrado",
"token": null,
"code": 404
}
erro: 500
{
"message": "atualização do código de autenticação falhou",
"token": null,
"code": 500
}
erro: 500
{
"message": "revogação do token falhou",
"token": null,
"code": 500
}
|
/api/revoke-token/{ACCESS_TOKEN} |
ACCESS_TOKEN
Token de acesso.
Composto de 32 digitos Alfanumérico. Ex: 4FFE2F70B6B915FD1C97B45EE9321377
|
GET |
Validação de um Token
Sucesso
{
"message": null,
"expires": "2017-05-02 18:33:21",
"code": 200
}
Erro
erro: 101
{
"message": "token expirado",
"expires": "2017-05-02 18:10:26",
"code": 101
}
erro: 410
{
"message": "token cancelado",
"expires": null,
"code": 410
}
erro: 500
{
"message": "falha ao verificar se o token expirou",
"expires": null,
"code": 500
}
|
/api/validate-token/{ACCESS_TOKEN} |
ACCESS_TOKEN
Token de acesso.
Composto de 32 digitos Alfanumérico. Ex: 4FFE2F70B6B915FD1C97B45EE9321377
|
GET |
Atualiza Token
Sucesso
{
"message": null,
"token": "1DC55F89F14BAAAEDB06CEA79C3DDD17",
"refresh_token": "155232C4FC7CB530232A341A8D8221CC",
"code": 200
}
Erro
erro: 403
{
"message": "refresh token bloqueado",
"token": null,
"refresh_token": null,
"code": 403
}
erro: 404
{
"message": "c\u00f3digo de autentica\u00e7\u00e3o n\u00e3o encontrado",
"token": null,
"refresh_token": null,
"code": 404
}
erro: 404
{
"message": "refresh token não encontrado",
"token": null,
"refresh_token": null,
"code": 404
}
erro: 500
{
"message": "atualização do código de autenticação falhou",
"expires": null,
"code": 500
}
|
/api/refresh-token/{REFRESH_TOKEN} |
REFRESH_TOKEN
Refresh Token.
Composto de 32 digitos Alfanumérico. Ex: 155232C4FC7CB530232A341A8D8221CC
|
GET |
Escopos Disponiveis do Token
Sucesso
{
"message": null,
"scopes": "{\u0022MUSICS\u0022:\u0022Musicas\u0022}",
"code": 200
}
Erro
erro: 500
{
"message": "falha ao buscar escopos.",
"scopes": null,
"code": 500
}
|
/api/scopes-token/{ACCESS_TOKEN}/{SCOPE_TYPE} |
ACCESS_TOKEN
Token de acesso.
Composto de 32 digitos Alfanumérico. Ex: 4FFE2F70B6B915FD1C97B45EE9321377
SCOPE_TYPE
Tipo dos Scops requisitados.
Tipos de Escopos Disponiveis: DOWNLOAD, UPLOAD, DELETE, NOTIFICATION, READ, CONFIGURATION
|
GET |
Busca Configurações da Estação
Sucesso
{
"status": "success",
"code": 200,
"data": {
"local_config": true,
"automatic_directory_management": false,
"remove_intruders": true,
"propagate_deletions": false,
"optimize_verifications": false,
"sync_interval": 1,
"partial_sync_interval": 0,
"complete_sync_interval": "00:00",
"update_products": false,
"has_password": false,
"available_download": true,
"available_upload": true,
"check_version_software": "03:00",
"timezone": "America/Sao_Paulo",
"nickname": "desenvolvedor"
}
}
|
/api/busca-config/{AUTH_CODE} |
AUTH_CODE
Código de autorização de uma maquina da empresa.
|
GET |
Atualiza Configurações da Estação
Sucesso
{
"status": "success",
"code": 200,
"message": "As configura\u00e7\u00f5es foram atualizadas com sucesso."
}
|
/api/atualiza-config-sync/{AUTH_CODE} |
AUTH_CODE
Código de autorização de uma maquina da empresa.
Parametros Post
(boolean) automatic_directory_management
(boolean) remove_musics
(boolean) remove_medias
(boolean) propagate_deletions
(boolean) optimize_verifications
(integer) partial_sync_interval
(string format: HH:mm) complete_sync_interval
(string) nickname
|
POST |
Validação da senha da estação do Sync
Sucesso
{
"status": "success",
"code": 200,
"message": null
}
Error
{
"status": "error",
"code": 500,
"message": "Desculpe a senha informada não coincide."
}
|
/api/compara-senha-sync/{AUTH_CODE} |
AUTH_CODE
Código de autorização de uma maquina da empresa.
Parametros Post
(string) password
|
POST |