Jamef API Publica API documentation version 1
Documetação oficial da API Jamef.
Documentação da API
Seja bem vindo a documentação da API Jamef para desenvolvedores.
O foco desta documentação é atender suas necessidades de informação para aconstrução de aplicações que precisem fazer uma integração com o mundo Jamef.
Dados da API
Aqui você irá buscar dados básicos para a API. Algumas informações são uteis como versão da aplicação e versão da API.
get /
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- message: required(string)
Mensagem padrão do sistema.
- url: required(string)
Endereço raiz para informações sobre API Jamef.
- dataGeracao: required(datetime)
Data do servidor usado na geração.
- environment: required(string)
Nome do ambiente que esta sendo executado.
- appversion: required(string)
Versão da aplicação.
- apiversion: required(integer)
Versão da api.
Example:
{
"message":"Seja bem vindo! Para maiores informações, acesse nossa página.",
"url":"http://developers.jamef.com.br",
"dataGeracao":"2018-03-13T14:06:05Z",
"environment":"development",
"appversion":"0.1",
"apiversion":1
}Efetuar login
post /login
Body
Media type: application/json
Type: object
Properties- password: required(string)
Senha do usuário.
- username: required(string)
Nome do login do usuário.
Example:
{
"username": "fulano",
"password": "mYP4sSw0rD"
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- username: required(string)
Nome do usuário
- roles: required(array of string)
Lista das permissões que o usuário possui
- token_type: required(string)
Tipo do token que é utilizado
- access_token: required(string)
Token de segurança fornecido para o usuário.
Example:
{
"username": "fulano",
"roles": [
"ROLE_USER"
],
"token_type": "Bearer",
"access_token": "n7du21e1r0ib765flpih0q3o5lv81c71"
}Sair do sistema
/info
Aqui você irá buscar dados básicos para a API. Algumas informações são uteis como a versão da aplicação e versão da API.
get /info/
Aqui você irá buscar dados básicos para a API. Algumas informações são uteis como a versão da aplicação e versão da API.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- message: required(string)
Mensagem padrão do sistema.
- url: required(string)
Endereço raiz para informações sobre API Jamef.
- dataGeracao: required(datetime)
Data do servidor usado na geração.
- environment: required(string)
Nome do ambiente que esta sendo executado.
- appversion: required(string)
Versão da aplicação.
- apiversion: required(integer)
Versão da api.
Example:
{
"message":"Seja bem vindo! Para maiores informações, acesse nossa página.",
"url":"http://developers.jamef.com.br",
"dataGeracao":"2018-03-13T14:06:05Z",
"environment":"development",
"appversion":"0.1",
"apiversion":1
}Irá retornar o código de todas as filiais disponíveis.
Esta informação poderá ser solicitada por outros end points.
get /info/listaFiliais
Irá retornar o código de todas as filiais disponíveis.
Esta informação poderá ser solicitada por outros end points.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- apiVersion: required(integer)
Versão da api
- listaFiliais: required(array of filial)
Lista das filiais
Items: Filial
- codigo: required(string)
Código da ficial, composta de três letras
- numero: required(string)
Número da filial
- descricao: required(string)
Descrição da Filial por extenso
- codigo: required(string)
Example:
{
"apiVersion": 1,
"listaFiliais": [
{
"numero": "31",
"codigo": "AJU",
"descricao": "ARACAJU"
},
{
"numero": "40",
"codigo": "BAR",
"descricao": "BARUERI"
},
{
"numero": "16",
"codigo": "BAU",
"descricao": "BAURU"
},
{
"numero": "02",
"codigo": "BHZ",
"descricao": "BELO HORIZONTE"
},
{
"numero": "09",
"codigo": "BNU",
"descricao": "BLUMENAU"
},
{
"numero": "28",
"codigo": "BSB",
"descricao": "BRASILIA"
},
{
"numero": "03",
"codigo": "CPQ",
"descricao": "CAMPINAS"
},
{
"numero": "04",
"codigo": "CWB",
"descricao": "CURITIBA"
},
{
"numero": "22",
"codigo": "CXJ",
"descricao": "CAXIAS DO SUL"
},
{
"numero": "38",
"codigo": "DIV",
"descricao": "DIVINOPOLIS"
},
{
"numero": "34",
"codigo": "FES",
"descricao": "FEIRA DE SANTANA"
},
{
"numero": "11",
"codigo": "FLN",
"descricao": "FLORIANOPOLIS"
},
{
"numero": "26",
"codigo": "CCM",
"descricao": "CRICIUMA"
},
{
"numero": "32",
"codigo": "FOR",
"descricao": "FORTALEZA"
},
{
"numero": "24",
"codigo": "GYN",
"descricao": "GOIANIA"
},
{
"numero": "23",
"codigo": "JDF",
"descricao": "JUIZ DE FORA"
},
{
"numero": "08",
"codigo": "JOI",
"descricao": "JOINVILLE"
},
{
"numero": "36",
"codigo": "JPA",
"descricao": "JOAO PESSOA"
},
{
"numero": "10",
"codigo": "LDB",
"descricao": "LONDRINA"
},
{
"numero": "25",
"codigo": "MAO",
"descricao": "MANAUS"
},
{
"numero": "33",
"codigo": "MCZ",
"descricao": "MACEIO"
},
{
"numero": "12",
"codigo": "MGF",
"descricao": "MARINGA"
},
{
"numero": "37",
"codigo": "NAT",
"descricao": "NATAL"
},
{
"numero": "05",
"codigo": "POA",
"descricao": "PORTO ALEGRE"
},
{
"numero": "27",
"codigo": "PSA",
"descricao": "POUSO ALEGRE"
},
{
"numero": "18",
"codigo": "RAO",
"descricao": "RIBEIRAO PRETO"
},
{
"numero": "30",
"codigo": "REC",
"descricao": "RECIFE"
},
{
"numero": "06",
"codigo": "RIO",
"descricao": "RIO DE JANEIRO"
},
{
"numero": "07",
"codigo": "SAO",
"descricao": "SAO PAULO"
},
{
"numero": "21",
"codigo": "SJK",
"descricao": "SAO JOSE DOS CAMPOS"
},
{
"numero": "20",
"codigo": "SJP",
"descricao": "SAO JOSE DO RIO PRETO"
},
{
"numero": "29",
"codigo": "SSA",
"descricao": "SALVADOR"
},
{
"numero": "17",
"codigo": "UDI",
"descricao": "UBERLANDIA"
},
{
"numero": "39",
"codigo": "VDC",
"descricao": "VITORIA DA CONQUISTA"
},
{
"numero": "14",
"codigo": "VIX",
"descricao": "VITORIA"
}
]
}Rastreamento
Busca informações de um rastreamento de carga.
post /rastreamento/ver
Busca informações de um rastreamento de carga.
Autenticação básica, onde informações de acesso são enviadas no header da requisição.
Body
Media type: application/json
Type: object
Properties- documentoResponsavelPagamento: required(string)
CNPJ / CPF do cliente que será responsável pelo pagamento.
- documentoDestinatario: (string)
CNPJ / CPF do cliente de destino (que receberá o produto).
- numeroNotaFiscal: (string)
Número da nota fiscal do produto.
- numeroSerieNotaFiscal: (string)
Número de série da nota fiscal do produto.
- codigoFilialOrigem: (string)
Código da Filial Jamef de embarque. Para maiores informações entre em contato com nossa Central de Relacionamento.
- conhecimentoTransporteEletronico: (string)
Número do Conhecimento de Transporte Eletrônico.
- numeroSerieConhecimentoTransporteEletronico: (string)
Número de Série do Conhecimento de Transporte Eletrônico.
- dataInicial: (string)
Período de intervalo inicial para rastrear cargas.
- dataFinal: (string)
Período de intervalo final para rastrear cargas.
Example:
{
"documentoResponsavelPagamento" : "00000000000000",
"documentoDestinatario": "00000000000000",
"numeroNotaFiscal": "000000000",
"numeroSerieNotaFiscal": "00",
"codigoFilialOrigem": "BHZ"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- nomeClienteOrigem: required(string)
Nome do cliente de destino
- ufOrigem: required(string)
Unidade Federativa de origem da carga
- municipioOrigem: required(string)
Município de origem da carga
- nomeClienteDestino: required(string)
Nome do cliente de destino
- ufDestino: required(string)
Unidade Federativa de destino da carga
- municipioDestino: required(string)
Município de destino da carga
- conhecimentoTransporteEletronico: required(string)
Número do Conhecimento de Transporte Eletrônico
- serieConhecimentoTransporteEletronico: required(string)
Série do Conhecimento de Transporte Eletrônico
- numeroNotaFiscal: required(string)
Número da Nota Fiscal
- valorFrete: required(string)
Valor do Frete
- dataPrevisaoEntrega: required(string)
Data de Previsão de Entrega
- linkImagemComprovanteEntrega: required(string)
Link da imagem do comprovante de entrega
- historico: required(array of historicoRastreamentoCarga)
Histórico de rastreamento da carga
Items: Histórico de Rastreamento de Carga
- statusRastreamento: required(one of ENTREGANDO, ENTREGA_REALIZADA, EM_VIAGEM)
Status de rsatreamento da carga
- dataAtualizacao: required(string)
Data de atualização do status
- numeroManifesto: required(string)
Número do Manifesto da Carga
- ufOrigem: required(string)
Unidade Federativa de origem da carga
- municipioOrigem: required(string)
Município de origem da carga
- ufDestino: required(string)
Unidade Federativa de destino da carga
- municipioDestino: required(string)
Município de destino da carga
- codigoOcorrencia: required(string)
Código da ocorrência de status de rastreamento
- statusRastreamento: required(one of ENTREGANDO, ENTREGA_REALIZADA, EM_VIAGEM)
Example:
{
"apiVersion": 1,
"conhecimentos": [
{
"nomeClienteOrigem": "INDUSTRIA DE TECNOLOGIA LTDA.",
"ufOrigem": "MG",
"municipioOrigem": "ITAJUBA",
"nomeClienteDestino": "MICRO BRASIL LTDA",
"ufDestino": "ES",
"municipioDestino": "SERRA",
"conhecimentoTransporteEletronico": "000999999",
"serieConhecimentoTransporteEletronico": "1",
"numeroNotaFiscal": "123456 999999 888888 777777",
"valorFrete": 3337.79,
"dataPrevisaoEntrega": "03/04/19",
"linkImagemComprovanteEntrega": "",
"historico": [
{
"statusRastreamento": "ENTREGA REALIZADA NORMALMENTE",
"dataAtualizacao": "03/04/19 20:04",
"numeroManifesto": "012345678",
"ufOrigem": "ES",
"municipioOrigem": "Serra",
"ufDestino": "ES",
"municipioDestino": "Serra",
"codigoOcorrencia": "099"
}
]
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- apiVersion: required(integer)
Versão da API.
- appVersion: required(string)
Versão da aplicação.
- message: required(any)
Objeto que detalha o erro. Não tem como ter um modelo definido do erro, uma vez que o objeto pode variar de acordo com o erro.
- error: required(integer)
Código de erro.
Secured by Básico
Headers
- Authorization: required(string)
Utilizado para enviar as informações de acesso.
Busca informações da imagem de um rastreio
get /rastreamento/verImagem/{x}/{arquivo}
Busca informações da imagem de um rastreio
Autenticação básica, onde informações de acesso são enviadas no header da requisição.
URI Parameters
- x: required(string)
- arquivo: required(string)
HTTP status code 200
Body
Media type: application/octet-stream
Type: any
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- apiVersion: required(integer)
Versão da API.
- appVersion: required(string)
Versão da aplicação.
- message: required(any)
Objeto que detalha o erro. Não tem como ter um modelo definido do erro, uma vez que o objeto pode variar de acordo com o erro.
- error: required(integer)
Código de erro.
Secured by Básico
Headers
- Authorization: required(string)
Utilizado para enviar as informações de acesso.
Meus dados
Responsável pela gestão do seu próprio usuário.
get /usuario/ver
Autenticação básica, onde informações de acesso são enviadas no header da requisição.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- username: required(string)
Login do usuário
- enabled: required(boolean)
Ativo
- dateCreated: required(string)
Data de criação
- lastUpdated: required(string)
Data de última atualização
- email: required(string)
E-mail
- nome: required(string)
Nome completo
- permissoes: required(array of string)
Lista das permissões
- documentos: (array of string)
Lista das permissões
Example:
{
"dateCreated": "04/06/2018",
"lastUpdated": "04/06/2018",
"nome": "Fulano de tal",
"username": "fulano",
"enabled": true,
"email": "fulano@jamef.com.br",
"apiVersion": 1,
"permissoes": [
"ROLE_USERS"
],
"documentos": [
"00000000019",
"MG-1000000"
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- apiVersion: required(integer)
Versão da API.
- appVersion: required(string)
Versão da aplicação.
- message: required(any)
Objeto que detalha o erro. Não tem como ter um modelo definido do erro, uma vez que o objeto pode variar de acordo com o erro.
- error: required(integer)
Código de erro.
Secured by Básico
Headers
- Authorization: required(string)
Utilizado para enviar as informações de acesso.
Altera os dados do próprio usuário.
Importante!
Caso não deseje alterar a senha, favor não enviar o campo password.
post /usuario/editar
Altera os dados do próprio usuário.
Importante!
Caso não deseje alterar a senha, favor não enviar o campo password.
Autenticação básica, onde informações de acesso são enviadas no header da requisição.
Body
Media type: application/json
Type: object
Properties- email: required(string)
- nome: required(string)
- password: (string)
Quando o campo senha é enviado, sua senha será substituída. Deixe em branco para não alterar.
Example:
{
"email": "fulano@jamef.com.br",
"nome": "Fulano da Silva",
"password": "senhafraca"
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(integer)
id do registro criado
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- apiVersion: required(integer)
Versão da API.
- appVersion: required(string)
Versão da aplicação.
- message: required(any)
Objeto que detalha o erro. Não tem como ter um modelo definido do erro, uma vez que o objeto pode variar de acordo com o erro.
- error: required(integer)
Código de erro.
Secured by Básico
Headers
- Authorization: required(string)
Utilizado para enviar as informações de acesso.
Recuperar a senha do usuário através de informações de username ou e-mail.
Uma nova senha aleatório será enviada para o e-mail do usuário.
post /usuario/recuperarSenha
Recuperar a senha do usuário através de informações de username ou e-mail.
Uma nova senha aleatório será enviada para o e-mail do usuário.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- usernameOuEmail: required(string)
Example:
{
"usernameOuEmail": "fulano"
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- apiVersion: required(integer)
Versão da API.
- appVersion: required(string)
Versão da aplicação.
- message: required(any)
Objeto que detalha o erro. Não tem como ter um modelo definido do erro, uma vez que o objeto pode variar de acordo com o erro.
- error: required(integer)
Código de erro.