Sites

Autenticação
A chave da API deve ser enviada como um token Bearer no cabeçalho Authorization da requisição. Obtenha sua chave de API.
Listar

Endpoint da API

GET
https://lens.oktopus.cloud/api/v1/websites

Exemplo de requisição

curl --location --request GET 'https://lens.oktopus.cloud/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parâmetros

Nome
Tipo
Descrição
search
opcional string
Consulta de pesquisa.
search_by
opcional string
Pesquisar por. Os valores possíveis são: domain para Domínio. O padrão é: domain.
sort_by
opcional string
Ordenar por. Os valores possíveis são: id para Data de criação, domain para Domínio, reports_avg_score para Pontuação, reports_count para Relatórios. O padrão é: id.
sort
opcional string
Ordenar. Os valores possíveis são: desc para Decrescente, asc para Crescente. O padrão é: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. O padrão é: 10.
Exibir

Endpoint da API

GET
https://lens.oktopus.cloud/api/v1/websites/{id}

Exemplo de requisição

curl --location --request GET 'https://lens.oktopus.cloud/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Atualizar

Endpoint da API

PUT PATCH
https://lens.oktopus.cloud/api/v1/websites/{id}

Exemplo de requisição

curl --location --request PUT 'https://lens.oktopus.cloud/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parâmetros

Nome
Tipo
Descrição
privacy
opcional integer
Privacidade. Os valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha.
password
opcional string
Senha. Funciona apenas com o campo privacy definido como 2.
Excluir

Endpoint da API

DELETE
https://lens.oktopus.cloud/api/v1/websites/{id}

Exemplo de requisição

curl --location --request DELETE 'https://lens.oktopus.cloud/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'