Documentação da API

Aprenda como conectar e integrar com nossa API.

Obtenha sua própria chave de API

URL Base

Autenticação

Todos os endpoints da API requerem uma chave de API enviada pelo método de autenticação Bearer.

Authorization: Bearer {api_key}

Exemplo

curl --request GET \
--url 'https://serpmax.ru/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Nossa API usa códigos de status HTTP convencionais para indicar o sucesso ou a falha de uma requisição.

Exemplo

{
    "errors": [
        {
            "title": "Voc\u00ea n\u00e3o tem acesso \u00e0 API.",
            "status": 401
        }
    ]
}

Códigos de status

200 Requisição concluída com sucesso

400 Requisição inválida - Parâmetros obrigatórios ausentes ou inválidos

401 Não autorizado - Chave de API ausente ou inválida

404 O recurso solicitado não foi encontrado

429 Muitas requisições - Limite de taxa excedido

500 Erro interno do servidor - isso significa que há um problema do nosso lado

Todos os resultados do endpoint da API funcionam com o fuso horário UTC, salvo indicação em contrário.

Usuário

Sites

Auditorias SEO

Auditorias arquivadas

Manipuladores de notificação

Domínios Personalizados

Minhas Equipes

Membros da equipe

Membro de equipes

Pagamentos da conta

Registros da conta