--- title: "Começar" description: "Guia de início para utilizar as APIs" url: "https://api-portal-suitelogi-ppr.stef.com/pt/getting-started" image: "https://api-portal-suitelogi-ppr.stef.com/_og/d/c_Ocean.takumi,title_~Q29tZcOnYXI,description_~R3VpYSBkZSBpbsOtY2lvIHBhcmEgdXRpbGl6YXIgYXMgQVBJcw,props_eyJ0aGVtZSI6eyJtb2RlIjoibGlnaHQiLCJjb2xvcnMiOnsicHJpbWFyeSI6IiM1NTk2ZTYifX19,p_Ii9wdC9nZXR0aW5nLXN0YXJ0ZWQi,s_RrKY7RamjyxIBmTA.png" --- **Portal do Desenvolvedor** - [APIs](https://api-portal-suitelogi-ppr.stef.com/pt/apis) - [Começar](https://api-portal-suitelogi-ppr.stef.com/pt/getting-started) - [Guias](https://api-portal-suitelogi-ppr.stef.com/pt/guides) - [Suporte](https://api-portal-suitelogi-ppr.stef.com/pt/support) [FR](https://api-portal-suitelogi-ppr.stef.com/)|[EN](https://api-portal-suitelogi-ppr.stef.com/en)|[ES](https://api-portal-suitelogi-ppr.stef.com/es)|[IT](https://api-portal-suitelogi-ppr.stef.com/it)|**[PT](https://api-portal-suitelogi-ppr.stef.com/pt)**|[NL](https://api-portal-suitelogi-ppr.stef.com/nl)|[DE](https://api-portal-suitelogi-ppr.stef.com/de) ## Começar com as APIs Siga este guia para iniciar sessão no portal, criar a sua aplicação, subscrever APIs e efetuar a sua primeira chamada. ## [1\. Ligar-se ao Portal API](#_1-ligar-se-ao-portal-api) Os portais API da STEF permitem-lhe subscrever as APIs da STEF através de aplicações consumidoras pessoais ou partilhadas no seio de uma equipa. Enquanto colaborador da STEF, não é necessário solicitar a criação de uma conta para aceder aos portais. Aceda ao portal pretendido e, no momento da autenticação, clique no botão **Iniciar sessão como colaborador STEF**. Consulte o guia das instâncias APIM para obter a lista dos portais disponíveis e respetivos usos. Para poder criar uma aplicação consumidora partilhada com a sua equipa, é necessário solicitar a criação de uma equipa através da abertura de um ticket JIRA APIM, indicando o nome da equipa e o(s) portal(is) de destino. ## [2\. Criar uma aplicação](#_2-criar-uma-aplicação) Para poder consumir uma API, deve primeiro dispor de uma aplicação consumidora. A sua criação gera uma **credential**, o identificador da sua aplicação durante uma chamada. 1. Clique no seu perfil no canto superior direito do portal 2. Clique no botão **[Applications](https://api-portal-suitelogi-ppr.stef.com/apps)** 3. Clique no botão **New application** 4. Indique o nome e a descrição da sua aplicação 5. Para partilhar esta aplicação com a sua equipa, selecione **This is a team owned application** e escolha a equipa pretendida 6. Clique no botão **Create application** 7. Anote a credential gerada no momento da criação Esta credential só aparece no momento da criação da sua aplicação e deixará de estar visível depois disso. Guarde-a cuidadosamente. ## [3\. Subscrever uma API](#_3-subscrever-uma-api) Uma aplicação consumidora pode subscrever uma ou várias APIs em função das suas necessidades. Utilize o menu **APIs** para consultar o catálogo das APIs STEF disponíveis. Navegue até aos produtos do seu interesse para visualizar a documentação técnica para programadores, que apresenta para cada API: - As diferentes operações suportadas - A definição dos objetos de entrada e de saída - Exemplos de código para as consumir Para subscrever uma API: 1. Abra o detalhe de uma API 2. Clique em **Use this API** no canto superior direito 3. Clique no botão **Register** associado à aplicação que pretende subscrever A subscrição deverá depois ser validada pela STEF; para isso, contacte o seu interlocutor STEF IT. Como uma aplicação pode subscrever várias APIs, repita o procedimento de subscrição para cada API que pretende utilizar. ### [Consultar e gerir as suas subscrições](#consultar-e-gerir-as-suas-subscrições) Para consultar as subscrições de uma aplicação, clique no seu perfil no canto superior esquerdo e depois em **Applications**; em seguida, clique no nome da sua aplicação. No separador **APIs**, apresentado automaticamente, encontra a lista das suas subscrições e o respetivo estado. Também pode solicitar a subscrição de outras APIs diretamente a partir deste menu, clicando em **\+ API**. ## [4\. Consumir uma API](#_4-consumir-uma-api) Todas as invocações das APIs da STEF passam pela Gateway API da STEF, de forma a aplicar as regras de segurança de acesso, assegurar a proteção dos serviços backend do sistema de informação da STEF e recolher estatísticas de invocação. As Gateway API estão acessíveis através dos seguintes URLs: - Produção: [https://api-suitelogi.stef.com](https://api-suitelogi.stef.com) - Qualificação: [https://api-suitelogi-qua.stef.com/](https://api-suitelogi-qua.stef.com/) Para consumir uma API e respeitar as regras de segurança de acesso, adicione o header HTTP `X-STEF-Client-Id` ao pedido, preenchido com a credential da sua aplicação consumidora. A documentação técnica para programadores propõe, para cada API publicada na plataforma, exemplos de código que permitem invocar a Gateway API a partir de diferentes linguagens: Shell, Python, Node.js, JavaScript, Go, Java, C# e Ruby. ### [Exemplo de invocação](#exemplo-de-invocação) ```bash curl -X GET "https://api.stef.com/v1/transport/orders" \ -H "X-STEF-Client-Id: " \ -H "Content-Type: application/json" ``` Além dos exemplos de código, a documentação técnica para programadores propõe formulários que permitem invocar as APIs diretamente a partir do portal, em modo interativo, através do botão **Try it!**. ## [Próximos passos](#próximos-passos) ## Catálogo de APIs [Ver as APIs →](https://api-portal-suitelogi-ppr.stef.com/pt/apis) ## Guias técnicos [Ver os guias →](https://api-portal-suitelogi-ppr.stef.com/pt/guides) ## Instâncias APIM [Ver instâncias →](https://api-portal-suitelogi-ppr.stef.com/pt/getting-started/instances) #### [APIs](#apis) - [Catálogo de APIs](https://api-portal-suitelogi-ppr.stef.com/pt/apis) - [Guia de início](https://api-portal-suitelogi-ppr.stef.com/pt/getting-started) #### [Desenvolvedores](#desenvolvedores) - [Documentação](https://api-portal-suitelogi-ppr.stef.com/pt/guides) - [Boas práticas](https://api-portal-suitelogi-ppr.stef.com/pt/guides/best-practices) - [Portais](https://api-portal-suitelogi-ppr.stef.com/pt/getting-started/instances) #### [Suporte](#suporte) - [Suporte técnico](https://api-portal-suitelogi-ppr.stef.com/pt/support) #### [Idiomas](#idiomas) - [Français](https://api-portal-suitelogi-ppr.stef.com/) - [English](https://api-portal-suitelogi-ppr.stef.com/en) - [Español](https://api-portal-suitelogi-ppr.stef.com/es) - [Italiano](https://api-portal-suitelogi-ppr.stef.com/it) - [Português](https://api-portal-suitelogi-ppr.stef.com/pt) - [Nederlands](https://api-portal-suitelogi-ppr.stef.com/nl) - [Deutsch](https://api-portal-suitelogi-ppr.stef.com/de) © 2026 STEF — Todos os direitos reservados [Mentions légales](https://www.stef.com/mentions-legales) · [Politique de confidentialité](https://www.stef.com/politique-confidentialite)