API Uptogo

Esta documentação reúne todas as informações necessárias para que você utilize a API Uptogo corretamente e realize suas integrações sem maiores dificuldades.

Em caso de dúvidas ou sugestões, entre em contato através do e-mail suporte@uptogo.com.br.

Autenticação

Para interagir com a API Uptogo corretamente é necessário informar a chave de acesso no cabeçalho de cada requisição.

Essa chave pode ser obtida na área de configurações do aplicativo cliente ou através do nosso setor de suporte.

Cada chave de acesso é única e intransferível.

O envio de dados alterados maliciosamente para a API Uptogo resulta na imediata revogação de acesso e no acionamento judicial do utilizador e dos demais envolvidos.

A chave de acesso é criptografada com o algoritmo SHA-256 e tem a seguinte aparência:

Authorization: Basic 46070d4bf934fb0d4b06d9e2c46e346944e322444900a435d7d9a95e6d7435f5

Localizações

Obter

GET https://api.uptogo.com.br/localizacaos/123
RequestsPadrão
Headers
Authorization: Basic <chave_acesso>
Responses200404401
Headers
Content-Type: application/json
Body
{
  "info": {
    "results": 1
  },
  "results": [
    {
      "Id": 123,
      "Latitude": -23.6170033,
      "Longitude": -46.6495394
    }
  ]
}
Body
Not Found
Body
Unauthorized

GET/localizacaos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Criar

POST https://api.uptogo.com.br/localizacaos?return=true
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "Latitude": -23.6170033,
  "Longitude": -46.6495394
}
Responses201400401
Headers
Content-Type: application/json
Body
{
  "Id": 123
}
Body
Bad Request
Body
Unauthorized

POST/localizacaos{?return}

URI Parameters
HideShow
return
boolean (optional) Example: true

Retorna o identificador do item criado


Atualizar

PUT https://api.uptogo.com.br/localizacaos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "Latitude": -23.6170033,
  "Longitude": -46.6495394
}
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

PUT/localizacaos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Apagar

DELETE https://api.uptogo.com.br/localizacaos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

DELETE/localizacaos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Local

Sugestões

GET https://api.uptogo.com.br/placeautocompletes?input=07262-206
RequestsPadrão
Headers
Authorization: Basic <chave_acesso>
Responses200401
Headers
Content-Type: application/json
Body
[
  {
    "id": "EjNSdWEgZGEgQ3JlY2hlIC0gSmFyZGltIEFubnksIEd1YXJ1bGhvcyAtIFNQLCBCcmFzaWwiLiosChQKEgnZhYo1DGPOlBFlbAWY2-EZTRIUChIJ3ZYoxQ5jzpQR-vkadONItnU",
    "label": "Rua da Creche - Jardim Anny, Guarulhos - SP"
  },
  {
    "id": "EkBSdWEgZGEgQ3JlY2hlIC0gSmFyZGltIEpvw6NvIFJvc3NpLCBSaWJlaXLDo28gUHJldG8gLSBTUCwgQnJhc2lsIi4qLAoUChIJ-8gErbS-uZQRSkXEYVLFD5USFAoSCTFgt3O0vrmUEdt_VyRJHLKj",
    "label": "Rua da Creche - Jardim João Rossi, Ribeirão Preto - SP"
  },
  {
    "id": "EjdSdWEgZGEgQ3JlY2hlIC0gSmFyZGltIE1hcmlsZGEsIFPDo28gUGF1bG8gLSBTUCwgQnJhc2lsIi4qLAoUChIJ6a4PLoRIzpQRyA3Vfu50IgwSFAoSCaNB1R98SM6UEdvUwy2OM7Kt",
    "label": "Rua da Creche - Jardim Marilda, São Paulo - SP"
  },
  {
    "id": "EjlCYyBkYSBDcmVjaGUgLSBKYXJkaW0gRmxvcmVzdGFsLCBJdGFjb2F0aWFyYSAtIEFNLCBCcmFzaWwiLiosChQKEglTYUwPJFRvkhG_Ru6lZ1tf3BIUChIJtcjfJys0b5IRYopfymXrQq8",
    "label": "Bc da Creche - Jardim Florestal, Itacoatiara - AM"
  }
]
Body
Unauthorized

GET/placeautocompletes{?input}

URI Parameters
HideShow
input
string (required) Example: 07262-206

Parâmetro de busca


Detalhes

GET https://api.uptogo.com.br/placedetails?input=EjNSdWEgZGEgQ3JlY2hlIC0gSmFyZGltIEFubnksIEd1YXJ1bGhvcyAtIFNQLCBCcmFzaWwiLiosChQKEgnZhYo1DGPOlBFlbAWY2-EZTRIUChIJ3ZYoxQ5jzpQR-vkadONItnU
RequestsPadrão
Headers
Authorization: Basic <chave_acesso>
Responses200401
Headers
Content-Type: application/json
Body
{
  "Cache": "2019-11-20T23:44:26-03:00",
  "Localizacao": {
    "Latitude": -23.4796166,
    "Longitude": -46.3940336
  },
  "Endereco": {
    "Logradouro": "Rua da Creche",
    "Numero": null,
    "Bairro": "Jardim Anny",
    "Cep": "07262206",
    "Cidade": "Guarulhos",
    "Estado": "SP"
  }
}
Body
Unauthorized

GET/placedetails{?input}

URI Parameters
HideShow
input
string (required) Example: EjNSdWEgZGEgQ3JlY2hlIC0gSmFyZGltIEFubnksIEd1YXJ1bGhvcyAtIFNQLCBCcmFzaWwiLiosChQKEgnZhYo1DGPOlBFlbAWY2-EZTRIUChIJ3ZYoxQ5jzpQR-vkadONItnU

Identificador do local


Endereços

Obter

GET https://api.uptogo.com.br/enderecos/123
RequestsPadrão
Headers
Authorization: Basic <chave_acesso>
Responses200404401
Headers
Content-Type: application/json
Body
{
  "info": {
    "results": 1
  },
  "results": [
    {
      "Id": 123,
      "Formatado": null,
      "Logradouro": "Rua Dom Antônio de Alvarenga",
      "Numero": "40",
      "Complemento": null,
      "Bairro": "Vila Gumercindo",
      "Cep": "04129030",
      "Cidade": "São Paulo",
      "Estado": "SP",
      "Comprovante": null
    }
  ]
}
Body
Not Found
Body
Unauthorized

GET/enderecos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Criar

POST https://api.uptogo.com.br/enderecos?return=true
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "Logradouro": "Rua Dom Antônio de Alvarenga",
  "Numero": "40",
  "Bairro": "Vila Gumercindo",
  "Cep": "04129030",
  "Cidade": "São Paulo",
  "Estado": "SP"
}
Responses201400401
Headers
Content-Type: application/json
Body
{
  "Id": 123
}
Body
Bad Request
Body
Unauthorized

POST/enderecos{?return}

URI Parameters
HideShow
return
boolean (optional) Example: true

Retorna o identificador do item criado


Atualizar

PUT https://api.uptogo.com.br/enderecos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "Logradouro": "Rua Dom Antônio de Alvarenga",
  "Numero": "40",
  "Bairro": "Vila Gumercindo",
  "Cep": "04129030",
  "Cidade": "São Paulo",
  "Estado": "SP"
}
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

PUT/enderecos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Apagar

DELETE https://api.uptogo.com.br/enderecos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

DELETE/enderecos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Pontos

Obter

GET https://api.uptogo.com.br/pontos/123
RequestsPadrão
Headers
Authorization: Basic <chave_acesso>
Responses200404401
Headers
Content-Type: application/json
Body
{
  "info": {
    "results": 1
  },
  "results": [
    {
      "Id": 123,
      "Concluido": true,
      "Label": "A",
      "Tarefa": "Entregar envelopes conforme orientação",
      "Notificar": null,
      "NomeContato": null,
      "Assinatura": null,
      "Foto": null,
      "Endereco": {
        "Id": 123,
        "Formatado": "Av. Dr. Arnaldo, 355 - Pacaembu - São Paulo/SP",
        "Logradouro": "Avenida Doutor Arnaldo",
        "Numero": "355",
        "Complemento": null,
        "Bairro": "Pacaembu",
        "Cep": "07262206",
        "Cidade": "São Paulo",
        "Estado": "SP",
        "Comprovante": null
      },
      "Localizacao": {
        "Id": 123,
        "Latitude": -23.5553139,
        "Longitude": -46.6684782
      }
    }
  ]
}
Body
Not Found
Body
Unauthorized

GET/pontos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Criar

POST https://api.uptogo.com.br/pontos?return=true
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "Label": "A",
  "Tarefa": "Entregar envelopes conforme orientação",
  "Notificar": "maria@gmail.com",
  "NomeContato": "Maria",
  "EnderecoId": 123,
  "LocalizacaoId": 123
}
Responses201400401
Headers
Content-Type: application/json
Body
{
  "Id": 123
}
Body
Bad Request
Body
Unauthorized

POST/pontos{?return}

URI Parameters
HideShow
return
boolean (optional) Example: true

Retorna o identificador do item criado


Atualizar

PUT https://api.uptogo.com.br/pontos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "Label": "A",
  "Tarefa": "Retirar envelopes",
  "Notificar": "joao@gmail.com",
  "NomeContato": "João"
}
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

PUT/pontos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Apagar

DELETE https://api.uptogo.com.br/pontos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

DELETE/pontos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Direções

Obter

Distâncias são mensuradas em quilômetros.

Dados temporais são mensurados em minutos.

Valores monetários são mensurados em reais.

POST https://api.uptogo.com.br/directions
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "Pontos": [
    {
      "Latitude": -23.480979,
      "Longitude": -46.3957136
    },
    {
      "Latitude": -23.4962302,
      "Longitude": -46.4097183
    },
    {
      "Latitude": -23.6019217,
      "Longitude": -46.6260632
    }
  ]
}
Responses201400401
Headers
Content-Type: application/json
Body
{
  "Distancia": 45.64,
  "Tempo": 72.42,
  "Valor": 101.15,
  "Pontos": 3,
  "Polyline": [
    [
      -23.48088,
      -46.39538
    ],
    [
      -23.47973,
      -46.39579
    ]
  ]
}
Body
Bad Request
Body
Unauthorized

POST/directions


Pedidos

Obter

GET https://api.uptogo.com.br/clientes/123/pedidos/123
RequestsPadrão
Headers
Authorization: Basic <chave_acesso>
Responses200404401
Headers
Content-Type: application/json
Body
{
  "info": {
    "results": 1
  },
  "results": [
    {
      "Id": 123,
      "SenhaRastreamento": null,
      "ClienteId": 123,
      "Nota": null,
      "CentroCusto": "Financeiro",
      "BoletoUrl": null,
      "Apagado": false,
      "Editando": false,
      "Cancelado": false,
      "CupomDesconto": null,
      "MetodoPagamento": 3,
      "Distancia": 24.64,
      "Tempo": 45.83,
      "Valor": 63.06,
      "CompetenciaInicio": "2019-03-01T00:00:00-03:00",
      "CompetenciaFim": "2019-04-01T00:00:00-03:00",
      "PagamentoConfirmado": false,
      "PropostaRealizada": true,
      "InicioEntrega": "2019-03-22T20:38:17-03:00",
      "FimEntrega": "2019-03-23T11:03:15-03:00",
      "InicioAgendadoPara": "2019-03-22T19:35:00-03:00",
      "Pontos": [
        {
          "Id": 1,
          "Concluido": true,
          "Label": "A",
          "Tarefa": "Retirar a mercadoria",
          "Notificar": null,
          "NomeContato": "Maria",
          "Assinatura": null,
          "Foto": null,
          "Endereco": {
            "Id": 1,
            "Formatado": "Rua Uganda, 156 - Jardim Santa Cecilia - Guarulhos/SP",
            "Logradouro": "Rua Uganda",
            "Numero": "156",
            "Complemento": null,
            "Bairro": null,
            "Cep": "07123370",
            "Cidade": "Guarulhos",
            "Estado": "SP",
            "Comprovante": null
          },
          "Localizacao": {
            "Id": 1,
            "Latitude": -23.4407733,
            "Longitude": -46.5267632
          }
        },
        {
          "Id": 2,
          "Concluido": true,
          "Label": "B",
          "Tarefa": "Entregar a mercadoria",
          "Notificar": null,
          "NomeContato": "João",
          "Assinatura": null,
          "Foto": null,
          "Endereco": {
            "Id": 2,
            "Formatado": "Avenida Benvindo Tolentino Neto, 388 - Bom Clima - Guarulhos/SP",
            "Logradouro": "Avenida Benvindo Tolentino Neto",
            "Numero": "388",
            "Complemento": null,
            "Bairro": null,
            "Cep": "07121270",
            "Cidade": "Guarulhos",
            "Estado": "SP",
            "Comprovante": null
          },
          "Localizacao": {
            "Id": 2,
            "Latitude": -23.4513666,
            "Longitude": -46.5214392
          }
        }
      ]
    }
  ]
}
Body
Not Found
Body
Unauthorized

GET/clientes/{cliente_id}/pedidos/{pedido_id}

URI Parameters
HideShow
cliente_id
number (required) Example: 123

Identificador do cliente

pedido_id
number (required) Example: 123

Identificador do pedido


Criar

O envio de dados alterados maliciosamente para a API Uptogo resulta na imediata revogação de acesso e no acionamento judicial do utilizador e dos demais envolvidos.

Utilize os dados retornados pela rota de direções. Quando você envia dados monetários para a API Uptogo, eles são recalculados e, caso haja alguma incongruência, medidas judiciais antifraude são acionadas.

Crie os dados complementares, como ponto, endereço e localização anteriormente para utilizar seus identificadores na criação de um novo pedido.

POST https://api.uptogo.com.br/pedidos?return=true
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "info": {
    "results": 1
  },
  "results": [
    {
      "SenhaRastreamento": "senha secreta",
      "CentroCusto": "Financeiro",
      "CupomDesconto": "ABC123",
      "Distancia": 24.64,
      "Tempo": 45.83,
      "Valor": 63.06,
      "InicioAgendadoPara": "2019-03-22T19:35:00-03:00",
      "Pontos": [
        1,
        2,
        3
      ]
    }
  ]
}
Responses201400401
Headers
Content-Type: application/json
Body
{
  "Id": 123
}
Body
Bad Request
Body
Unauthorized

POST/pedidos{?return}

URI Parameters
HideShow
return
boolean (optional) Example: true

Retorna o identificador do item criado


Atualizar

PUT https://api.uptogo.com.br/pedidos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Body
{
  "SenhaRastreamento": "senha secreta",
  "CentroCusto": "Financeiro",
  "CupomDesconto": "ABC123",
  "InicioAgendadoPara": "2019-03-22T19:35:00-03:00"
}
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

PUT/pedidos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Apagar

DELETE https://api.uptogo.com.br/pedidos/123
RequestsPadrão
Headers
Content-Type: application/json
Authorization: Basic <chave_acesso>
Responses200404400401
Body
OK
Body
Not Found
Body
Bad Request
Body
Unauthorized

DELETE/pedidos/{id}

URI Parameters
HideShow
id
number (required) Example: 123

Identificador do item


Generated by aglio on 21 Nov 2019