Introdução

Esta API permite conectar-se à nossa plataforma e gerir automaticamente diferentes recursos. Em vez de realizar ações manualmente — como criar itens ou consultar informações através de uma interface web —, pode fazê-lo enviando pedidos a partir da sua aplicação ou de scripts.

Se nunca utilizou uma API antes, não se preocupe: a ideia principal é que você envia um pedido para um endereço específico (um endpoint), e a plataforma devolve uma resposta em JSON formato, que é um formato de texto muito fácil de ler.

A API está organizada em diferentes secções, cada uma dedicada a um tipo de recurso. Por exemplo, pode haver secções para criar recursos, listar os que já possui ou atualizar a respetiva configuração. Cada ação é executada usando métodos HTTP bem conhecidos, como GET, POST, PUT, PATCH ou DELETE.

Para o utilizar de forma segura, precisará de um token que o identifique como utilizador autorizado. Também fornecemos ferramentas como paginação, filtros e mensagens de erro claras para o ajudar a compreender o que está a acontecer em cada etapa.

Este documento é um guia inicial para o ajudar a familiarizar-se com a estrutura geral da API e começar a integrá-la nas suas próprias aplicações, mesmo que não tenha experiência prévia.