Routes.md

API - Rotas

Dicionário de Parâmetros

Parâmetro	Header/Body	Tipo	Descrição
token	Header	String	Token de permissão do usuário
agency	Header	String	Agência do usuário
company	Header	String	Empresa proprietária do adinfo
permission	Header	String	Nível de permissão do usuário, podendo ser: user, admin ou owner
data	Body	File	Arquivo CSV
file	Header	String	Nome do arquivo salvo no banco de arquivos (não informar a extensão)
config	Body	String	String correspondente ao JSON de configuração
campaign	Header	String	Nome da campanha
email	Body	String	Email do usuário
password	Body	String	Senha do usuário
newPassword	Body	String	Nova senha do usuário

Rotas

(POST) /login

Parâmetros: email, password

Descrição: Realiza o login na aplicação e retorna um token de autenticação.

(POST) /logout

Parâmetros: token

Descrição: Realiza o logout da aplicação.

(GET) /user

Parâmetros: token

Descrição: Recupera os dados do usuários(agência, nível de permissão e empresa) por meio do token informado.

(GET) /users

Parâmetros: token

Descrição: Recupera todos os dados do usuários(agência, nível de permissão, empresa e status).

(POST) /user/changepass

Parâmetros: token, password, newpassword

Descrição: Altera a senha do usuário que está realizando a requisição.

(POST) /user/:id/deactivate

Parâmetros: token

Descrição: Desativa o usuário com o ID enviado.

(POST) /user/:id/reactivate

Parâmetros: token

Descrição: Re-ativa o usuário com o ID enviado.

(GET) /template

Parâmetros: token

Descrição: Retorna um CSV com as colunas a serem preenchidas, baseando-se no campo columns (colunas) da configuração.

(GET) /template/excel

Parâmetros: token

Descrição: Retorna um arquivo Excel (xlsx) com as colunas a serem preenchidas, baseando-se no campo columns (colunas) da configuração e as regras de validação.

(POST) /register

Parâmetros: token, agency, permission, company, email.

Restrição: Apenas tokens de usuários com nível de permissão adm ou owner podem acessar esta rota.

Descrição: Cria um novo usuário da API de acordo com os parâmetros de: agency, company, permission e email informados, e retorna um token de acesso do novo usuário. Caso o nível de permissão informado para o novo usuário seja admin, não é necessário informar o parâmetro agency.

(POST) /csv

Parâmetros: token, data, campaign.

Descrição: Armazena o arquivo CSV passado no data no banco arquivos.

(GET) /csv

Parâmetros: token, file, campaign.

Descrição: Recupera o arquivo CSV especificado no parâmetro file.

(GET) /csv/list

Parâmetros: token, campaign.

Descrição: Retorna uma lista de todos os CSVs disponíveis no banco de arquivos, exibindo apenas os CSVs enviados pela agência do usuário solicitante.

(POST) /config

Parâmetros: token, config.

Descrição: Cria uma nova versão da configuração, de acordo com o parâmetro config informado. A nova configuração deve conter obrigatoriamente os campos: columns, csvSeparator, separator, spaceSeparator e pelo menos uma ferramenta de análise (ga ou adobe).

(GET) /config

Parâmetros: token.

Descrição: Retorna o JSON referente a configuração atual.

(POST) /build/:analyticsTool/:media

Parâmetros: token, data.

Descrição: Armazena o arquivo passado no parâmetro data no banco de arquivos e retorna um CSV com os campos de parametrização preenchidos, de acordo com a ferramenta de mídia informada na variável analyticsTool e na mídia informada na variável :media.

(POST) /campaign

Parâmetros: campaign, date.

Descrição: Cria uma nova campanha com o nome passado no parâmetro campaign e com data de criação informada na variável date.

(GET) /agencies/campaigns

Parâmetros: token.

Descrição: Retorna todas as campanhas de todas as agências da companhia.

(GET) /campaign/:agency/list

Parâmetros: token.

Descrição: Retorna todas as campanhas de uma campanha em específico.

(GET) /:agency/:campaignId/csv/list

Parâmetros: token.

Descrição: Retorna todas os CSVs parametrizados de determinada campanha.

(POST) /campaign/:id/deactivate

Parâmetros: token.

Descrição: Desativa a campanha com o campaignId enviado.

(POST) /campaign/:id/reactivate

Parâmetros: token.

Descrição: Re-ativa a campanha com o campaignId enviado.

(GET) /agency/list

Parâmetros: token.

Descrição: Retorna todas as agências da companhia.

(GET) /agency/users

Parâmetros: token.

Descrição: Retorna todos os users de uma agência.