Documentação da API

Aprenda como se conectar e integrar com nossa API.

URL base

Autenticação

Todas as solicitações de API requerem autenticação por meio de uma chave de API enviada através do cabeçalho Autorização conforme mostrado abaixo.

Authorization: Bearer {api_key}

Exemplo

curl --request GET \
--url 'https://jkznetwork.net/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 solicitação.

Exemplo

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

Códigos de status

200 Solicitação concluída com sucesso

400 Solicitação incorreta – Parâmetros obrigatórios ausentes ou inválidos

401 Não autorizado – a chave de API está ausente ou é inválida

404 O recurso solicitado não foi encontrado

429 Muitas solicitaçõ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 UTC fuso horário, a menos que especificado de outra forma.

Usuário

Ligações

Estatísticas de links

Projetos

Pixels

Páginas iniciais

Códigos QR

Assinaturas

Dados

Manipuladores de notificação

Equipes

Membros da equipe

Membro das equipes

Pagamentos de conta

Registros de conta