Este guia explica resumidamente como começar a utilizar a API REST no ConnectedCooking. Por favor, tenha em mente que este guia refere-se apenas às nossas soluções Cloud REST API.
- Em primeiro lugar, é necessário criar um cliente API na nossa conta ConnectedCooking. Por isso, navegamos na nossa conta ConnectedCooking para o separador Administration (Administração).
- Em seguida, clique em Integrações. O separador API só é visível para os administradores de conta.
- Em seguida, clique em "+ Adicionar novo"
- Na imagem seguinte, fornece um "ALIAS", atribui um GRUPO e escolhe um tipo de API. Para as consultas da API relativas ao HACCP e aos dados da sua conta ConnectedCooking, necessita do tipo de API "Base API". Depois de preencher todas as colunas, clique em "Add API" (Adicionar API).
- No ecrã seguinte, recebe as suas credenciais de cliente API. Guarde-as num local seguro e clique em fechar.
- Depois de ter criado o seu cliente API, precisa de uma ferramenta para o utilizar. Para isso, pode utilizar o curl, o Postman ou qualquer outra ferramenta que conheça. Neste guia, usamos o Postman.
- Inicie o Postman através de uma aplicação ou de um navegador Web. Em seguida, crie uma nova coleção em branco através do símbolo + e clique depois em "Adicionar um pedido". Em alternativa, pode também criar um novo pedido HTTP clicando em "Novo".
- Além disso, tem de editar o seu novo pedido criado para um pedido POST para receber o Token Portador com a ajuda das suas credenciais de Cliente API do ConnectedCooking.
- Por conseguinte, é necessário consultar a documentação da APIAutenticação | Centro de Ajuda do ConnectedCooking
- A documentação explica que é necessário criar um Token de portador para autenticar os seus pedidos de API adicionais.
- Isto é conseguido através de um pedido POST. O pedido POST utiliza o endpoint:https://app.connectedcooking.com/api/auth/access
- Além disso, tem de definir o Content-Type "x-www-form-urlencoded" no separador do corpo do seu pedido. Em seguida, o nome de utilizador, a palavra-passe e o âmbito do seu cliente API devem ser inseridos nas colunas disponíveis.
- No final, clique em "Send" (Enviar) e deverá receber o seu "accessToken = BearerToken"
- Para utilizar o seu BearerToken recém-criado, precisa de qualquer API para o utilizar.
- Pode verificar facilmente todos os pedidos de API possíveis na documentação dos pontos finais:Pontos de extremidade | Centro de Ajuda do ConnectedCooking
- Por exemplo, tente utilizar a lista de dispositivos Endpoint.
- Este pedido é muito simples, pois basta utilizar "https://app.connectedcooking.com" e adicionar "/api/public/devices" ao mesmo e copiar/colar o "accessToken" do pedido POST no separador Authorization (Autorização), como na imagem abaixo. Só tem de selecionar "Bearer Token" em Auth Type e, em seguida, o campo Token será apresentado.
- No final, clique também em "Enviar" e deverá receber uma lista de todos os dispositivos registados na sua conta ConnectedCooking (esta lista está vazia se não tiver dispositivos na sua conta).
Este exemplo pode basicamente ser aplicado a todos os pontos finais.
Parabéns, agora já pode utilizar APIs REST com o ConnectedCooking!
Se necessitar de informações adicionais, consulte a nossa Documentação API para ConnectedCooking:Introdução | Centro de Ajuda do ConnectedCooking
