As mesmas operações
O que faz no ecrã, faz por chamada: sites, conteúdos, imagens, temas, menus, redireccionamentos, publicação, Search Console. A documentação lista cada operação, uma a uma.
Programadores
O Joornal comanda-se pela API
Tudo o que o back-office faz também se faz pela API: criar um site, importar conteúdos, publicar, ler os dados da Search Console. Com as suas ferramentas, nos seus processos, com as mesmas permissões dos seus utilizadores.
O mesmo que a interface, sem a interface
Esta API não é um subconjunto concedido a contragosto. É a mesma aplicação, vista pelo outro lado.
As mesmas permissões
Um token só alcança o âmbito do seu portador: o seu cliente, os seus projectos, os seus sites. Um recurso fora dele responde 403. Não há uma «conta de API» à parte, com regras próprias a manter actualizadas.
Sem sessão, sem cookie
Um cabeçalho X-API-TOKEN por chamada, verificado de cada vez. Nada para abrir, nada para renovar, nada para guardar no navegador.
Erros que se parecem
Um contrato de erro único em toda a API: um código estável legível por máquina, uma mensagem legível por pessoas, e o detalhe campo a campo quando uma validação falha. Escreve o tratamento de erros uma vez.
O que comanda
Os usos que mais aparecem em agências e grupos multimarca.
Alimentar a partir dos seus sistemas
Importação de conteúdos em massa, idempotente: repetir a mesma chamada não cria duplicados, e decide se deixa o existente em paz ou se o actualiza. Pode antedatar, agendar uma publicação, associar categorias e signatários, e enviar as imagens no mesmo movimento.
Retomar um site existente
Migração a partir do WordPress ou de uma exportação, e depois a entrada em serviço: tema, domínio, redireccionamentos, sitemap. O parque cria-se e configura-se por chamada, não por pedido de suporte.
Publicar no momento certo
Desencadear uma publicação, reagendar uma fila de artigos, seguir o avanço. As operações longas devolvem um identificador de tarefa que consulta até ao fim.
Trazer os dados de volta
Desempenho da Search Console por artigo, estado de indexação URL a URL, estatísticas de passagem dos robôs, contactos vindos do formulário. Para alimentar os seus painéis em vez de os copiar à mão.
Aquilo com que pode contar
Uma API que se liga é uma API cujas regras se conhecem de antemão. As nossas estão escritas na documentação, não num contrato que é preciso pedir.
Um ano após a descontinuação
Um campo ou uma operação a caminho de desaparecer são primeiro marcados na especificação, com o seu substituto e a data da marca. Continuam a ser servidos pelo menos um ano a contar dessa data. Tem sempre um ano inteiro para mudar.
Uma especificação que não mente
A especificação OpenAPI é pública, e a nossa integração contínua recusa qualquer alteração da API que não venha acompanhada da actualização da documentação. A documentação não pode ficar para trás em silêncio: mostra a data da sua última revisão.
Limites anunciados
Cada resposta traz o saldo que lhe resta. Nunca tem de descobrir um limite ao embater nele, e pode abrandar antes que ele o pare.
Um filtro desconhecido é recusado
Um parâmetro mal escrito ou descontinuado produz um erro, nunca um resultado que apenas parece certo. É o género de pormenor que só se nota no dia em que já custou uma semana.
Retome o controlo da sua visibilidade
Marque uma demonstração personalizada e descubra como construir um meio de comunicação estruturado, eficaz e orientado pelos dados.