RetailForce Cloud API

A RetailForce Cloud API disponibiliza todas as funcionalidades do RetailForce Cloud Portal. Esta pode ser utilizada para automatizar processos ou para aceder a funcionalidades a partir de sistemas externos, sem necessidade de iniciar sessão no portal nem de realizar atividades manualmente.

Autenticação

Para utilizar as funções, o sistema solicitante deve autenticar-se junto do sistema na Cloud. A seguir, descreve-se a autenticação manual, bem como exemplos de chamadas orientadas por eventos.

Acesso através da RetailForce Cloud API

A Cloud API está disponível no seguinte URL:

• https://api.retailforce.cloud/swagger/index.html

Autenticação manual

A autenticação é efetuada através da cloudApiKey e do cloudApiSecret e da geração de um Bearer Token.

1. Ponto de contacto

1. Clique no ponto de extremidade POST /api/v1.0/authenticate/logon para expandir a secção.
2. Introduza o seu apiKey e apiKeySecret nos campos correspondentes.
3. Execute o pedido para receber um Bearer Token.

2. Utilizar o Bearer Token

1. Copie o Bearer Token do ResponseBody.
2. Clique no botão «Autorizar» no canto superior direito da Swagger UI.
3. Introduza o Bearer Token na caixa de diálogo. Formato: Bearer <token> (insira um espaço após «Bearer»).
4. Clique em «Autorizar»

Autenticação automática

A autenticação automática permite que os sistemas acedam de forma segura à RetailForce Cloud API sem interação do utilizador, sendo ideal para serviços em segundo plano, fluxos de trabalho automatizados ou consultas regulares de dados.

1. Autenticação e receção do token Bearer:

Envie um pedido POST com as suas credenciais da api para o ponto final de autenticação.

curl -X POST "https://api.retailforce.cloud/api/v1.0/authenticate/logon" \
-H "Content-Type: multipart/form-data" \
-F "key=cloudApiKey" \
-F "secret=cloudApiSecret"

Após a autenticação bem-sucedida, receberá um token «Bearer» no ResponseBody, o qual é necessário para autorizar futuras solicitações à api.

2. Aceder aos pontos finais:

Utilize o token «Bearer» recebido para aceder aos pontos de extremidade.

Exemplo:

curl -X 'GET' \
'https://api.retailforce.cloud/api/v1.0/someEndpoint' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {yourBearerToken}'

Importante: Mantenha as suas credenciais e tokens da api em segurança para evitar o acesso não autorizado.

Fiscalização na Cloud

«Fiscalização na nuvem» refere-se ao fornecimento do middleware de fiscalização da RetailForce como um serviço alojado na nuvem. O serviço é operado pela RetailForce no ambiente de nuvem.

Aceda através de fiscalisation.retailforce.cloud

Aceda ao serviço através da seguinte ligação:

• https://fiscalisation.RetailForceCloud.cloud/swagger/index.html

Autenticação manual

Existem duas opções para a autenticação na Fiscalização na RetailForce Cloud através da interface Swagger UI:

1. Abra a Swagger UI e clique em «Autorizar».
2. Métodos de autenticação
   1. Credenciais do portal (e-mail e palavra-passe):
      • Permitem o acesso a várias organizações.
   2. Chave API e segredo:
      • Normalmente associadas a um distribuidor ou organização específicos.
3. Clique em «Autorizar»

Está agora autorizado a testar e a começar a utilizar a fiscalização na Cloud.

Este artigo foi traduzido automaticamente.