Sites

Observações
Expert level
O API key deve be sent as um Bearer token no Authorization header do request. Get your API key.
Listar

API endpoint:

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

Request example: 

curl --location --request GET 'https://seo.oktopus.cloud/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
Consulta de busca.
search_by
opcional string
Buscar por. Valores possíveis: domain for Domínio. Padrão: domain.
sort_by
opcional string
Ordenar por. Valores possíveis: id for Data de criação, domain for Domínio, reports_avg_score for Pontuação, reports_count for Relatórios. Padrão: id.
sort
opcional string
Ordenar. Valores possíveis: desc for Decrescente, asc for Crescente. Padrão: desc.
per_page
opcional integer
Resultados por página. Valores possíveis: 10, 25, 50, 100. Padrão: 10.
Mostrar

API endpoint:

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

Request example: 

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

API endpoint:

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

Request example: 

curl --location --request PUT 'https://seo.oktopus.cloud/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
privacy
opcional integer
Privacidade. Valores possíveis: 0 for Público, 1 for Privado, 2 for Senha.
password
opcional string
Senha. Only works com privacy field set para 2.
Excluir

API endpoint:

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

Request example: 

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