VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Equipe de campo

Nomes alternativos dos check-ins

Os endereços ec_checkin e eccheckin, equivalentes a checkins, usados pelos apps de representantes já instalados.

O app de representantes antigo chama o check-in de ec_checkin (nome da Venddor 1.0) ou eccheckin (nome do app, sem sublinhado), no lugar de checkins. Os endereços desta página executam o mesmo código de Check-ins de visita: mesmo corpo, mesma resposta, mesmos erros.

Valem os mesmos avisos: route_id e manager_id são texto no JSON, e a forma /api (sem versão) pode trocar o route_id pelo id de outro registro. Prefira /api/v1.0. Todos exigem um usuário administrador.

POST/api/v1.0/ec_checkinAdmin

Mesmo que checkins (POST), forma com versão

Igual a POST /api/v1.0/checkins. Responde 201 quando grava.

Corpo da requisição

route_idstringobrigatório
Id da rota, como texto.
manager_idstringobrigatório
Id do representante, como texto.
latitudenumberobrigatório
Latitude em graus decimais.
longitudenumberobrigatório
Longitude em graus decimais.
notesstring
Observação livre.
GET/api/v1.0/ec_checkin/{manager_id}Admin

Mesmo que checkins (GET), forma com versão

Igual a GET /api/v1.0/checkins/{manager_id}: até 500 check-ins do representante, do mais novo para o mais antigo.

Parâmetros de caminho

manager_idstringobrigatório
Id do representante (inteiro).
POST/api/ec_checkinAdmin

Mesmo que checkins (POST), forma sem versão

Igual a POST /api/checkins. Responde 201 quando grava.

Corpo da requisição

route_idstringobrigatório
Id da rota, como texto.
manager_idstringobrigatório
Id do representante, como texto.
latitudenumberobrigatório
Latitude em graus decimais.
longitudenumberobrigatório
Longitude em graus decimais.
notesstring
Observação livre.
GET/api/ec_checkin/{manager_id}Admin

Mesmo que checkins (GET), forma sem versão

Igual a GET /api/checkins/{manager_id}: até 500 check-ins do representante, do mais novo para o mais antigo.

Parâmetros de caminho

manager_idstringobrigatório
Id do representante (inteiro).
POST/api/v1.0/eccheckinAdmin

Mesmo que checkins (POST), forma com versão

Igual a POST /api/v1.0/checkins. Responde 201 quando grava.

Corpo da requisição

route_idstringobrigatório
Id da rota, como texto.
manager_idstringobrigatório
Id do representante, como texto.
latitudenumberobrigatório
Latitude em graus decimais.
longitudenumberobrigatório
Longitude em graus decimais.
notesstring
Observação livre.
GET/api/v1.0/eccheckin/{manager_id}Admin

Mesmo que checkins (GET), forma com versão

Igual a GET /api/v1.0/checkins/{manager_id}: até 500 check-ins do representante, do mais novo para o mais antigo.

Parâmetros de caminho

manager_idstringobrigatório
Id do representante (inteiro).
POST/api/eccheckinAdmin

Mesmo que checkins (POST), forma sem versão

Igual a POST /api/checkins. Responde 201 quando grava.

Corpo da requisição

route_idstringobrigatório
Id da rota, como texto.
manager_idstringobrigatório
Id do representante, como texto.
latitudenumberobrigatório
Latitude em graus decimais.
longitudenumberobrigatório
Longitude em graus decimais.
notesstring
Observação livre.
GET/api/eccheckin/{manager_id}Admin

Mesmo que checkins (GET), forma sem versão

Igual a GET /api/checkins/{manager_id}: até 500 check-ins do representante, do mais novo para o mais antigo.

Parâmetros de caminho

manager_idstringobrigatório
Id do representante (inteiro).

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1.0/ec_checkin" \
  -u "$ADMIN_EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"route_id":"2","manager_id":"2","latitude":-23.5614,"longitude":-46.6559}'

curl "$BASE_URL/api/v1.0/eccheckin/2" -u "$ADMIN_EMAIL:$API_KEY"

Resposta

201Check-in gravado
json
{ "success": true, "checkin_id": 14 }

A lista de check-ins tem o mesmo formato descrito em Check-ins de visita.

Erros

Os mesmos de Check-ins de visita: 400 para corpo inválido, rota inexistente ou de outro representante e coordenadas zeradas; 401 sem credencial; 403 para quem não é administrador; 500 Query failed quando o manager_id do caminho não é número.

Escolha um nome só

Os três nomes (checkins, ec_checkin, eccheckin) são equivalentes. Fixe um no app para que os logs do servidor mostrem sempre o mesmo caminho.

Veja também

  • Check-ins de visita
  • Conta-corrente do representante
Anterior
Check-ins de visita
Próxima
Conta-corrente do representante
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também