ApiPharma Integração 1.0.0
[ Base URL: localhost:8080/ ]http://localhost:8080/v2/api-docs
Descrição da API do AppPharma:
A API do AppPharma oferece uma integração perfeita entre o aplicativo e as lojas de farmácias parceiras, permitindo um acompanhamento detalhado das transações de compras realizadas pelos usuários através da plataforma.
Ao efetuar uma compra no site do AppPharma e selecionar a opção "Compre já" com uma loja específica, o comprador será automaticamente redirecionado para o site oficial da loja em questão.
Para aprimorar a experiência do cliente e manter um registro eficiente das origens das transações, cada loja deverá armazenar em cache a informação de que o cliente descobriu a loja por meio do AppPharma. Essa informação será armazenada em cache pelo período de 30 dias, garantindo que eventuais compras subsequentes também sejam corretamente associadas ao AppPharma.
Após a conclusão da compra, a loja enviará uma requisição para o back-end do AppPharma, notificando sobre a transação realizada. Essa ação requer autenticação por meio de um Token gerado exclusivamente pelo AppPharma, garantindo a segurança e a validade da notificação.
Todas as Requsições feitas na back-end do AppPharma serão autenticadas através de um Token (Bearer Token).
A notificação enviada pela loja conterá o ID da loja, o ID do usuário e o ID da transação. Essas informações são fundamentais para que o AppPharma identifique a transação na base de dados da loja, permitindo um rastreamento eficaz de todas as operações realizadas.
Uma vez notificado, o back-end do AppPharma fará uma requisição para a base de dados da loja, utilizando o ID da transação, a fim de validar a operação correta e obter todos os detalhes relevantes da transação realizada. Essa abordagem garante que todas as informações estejam consistentes e atualizadas entre as plataformas.
Nos casos em que a operação envolva apenas uma alteração no status da transação, a loja enviará uma requisição ao AppPharma contendo o ID da loja, o ID do usuário e o ID da transação. Essa ação permitirá que o AppPharma faça uma nova requisição à base de dados da loja para obter os detalhes da atualização (por exemplo: "compra confirmada", "cancelada", entre outros). Dessa forma, ambas as plataformas estarão sempre sincronizadas em relação ao andamento das transações, garantindo uma experiência confiável e transparente para os usuários e parceiros.
public-cashback-resourcePublic Cashback Resource
Public Cashback Resource
Exemplo de Api necessária para podermos pegar as informações da transação
Parameters
| Name | Description |
|---|---|
IdTransaction * integer($int64) (query) | IdTransaction |
Responses
| Code | Description |
| 200 | OK {
"commissionAmount": 0,
"commissionStatus": "string",
"idStore": 0,
"idTransaction": 0,
"salesAmount": 0,
"transactionDate": "2023-07-25T13:53:22.767Z"
} |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Responsável por avisar que o status da compra foi alterado (Ex: Cancelado, Confirmado...)
Parameters
| Name | Description |
|---|---|
IdStore * integer($int64) (body) | IdStore |
IdTransaction integer($int64) (query) | IdTransaction |
Responses
| Code | Description |
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Responsável por avisar que a compra foi efetuada
Parameters
| Name | Description |
|---|---|
IdStore * integer($int64) (body) | IdStore |
IdTransaction integer($int64) (query) | IdTransaction |
IdUser integer($int64) (query) | IdUser |
Responses
| Code | Description |
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Models
| commissionAmount | number($float) Valor da Comissão |
| commissionStatus | string Status da Venda |
| idStore | integer($int64) Id da loja onde foi efetuada a Venda |
| idTransaction | integer($int64) Id da Transação |
| salesAmount | number($float) Valor da Venda |
| transactionDate | string($date-time) Data e Hora da Transação |