API Reference

Roteiro de Venda

Introdução

Nesta seção apresentamos o roteiro de vendas para o produto STARBEM. Para obter as informações do produto que serão utilizadas realize a operação Consultar Produtos disponível no anexo de Consultas

Consultar valores dos produtos

Para se obter o valor do produto e o id do produto STARBEM que será utilizado na venda, deve se consumir antes de qualquer solicitação de venda a operação Consulta Valores StarBem .

Exemplo de REQUEST:

GET /venda/starbem/81AA1C20B1688E4C7424C4E000334DD4/Psiquiatra/valores HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjg3ODkyMjU5LCJleHAiOjE2ODc4OTI1NTksIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.FAw4IjNjWTOKPXSVA7FG3LAVzhQYHet5doHFfuxJHWs
Host: sandbox.grupocard.com.br

Exemplo de RESPONSE:

{
  "nomeProdutoParceiro": "Consulta Psiquiatra",
  "valorProdutoParceiro": "119,97",
  "produtoIdParceiro": "4f32072b-8431-4b15-9528-8f91110f84bd"
}

Fluxo de sucesso

1 - Consumir a operação Solicitar Venda:

Utilize essa operação para solicitar a venda de qualquer produto disponível no estabelecimento. Este serviço faz apenas a SOLICITAÇÃO da venda, portanto, se na resposta desta operação o campo "status" for igual a AUTORIZADA, na sequência a confirmação da transação deve ser enviada através da operação a seguir: Confirmar Venda

Obs. 1: Se ao invocar essa operação o cliente não obter uma resposta, é ALTAMENTE RECOMENDADO que seja realizado o cancelamento da solicitação.

Obs. 2: A representação dos centavos no campo "valor" não deve ter separação por virgula e seu valor é obtido da operação anterior Consulta Valores StarBem do campo "valorProdutoParceiro". Ex: R$119,97 = 11997.

Obs.3: O campo "idExterno" é o identificador da requisição, sendo assim, deve ser enviado com um valor DIFERENTE a cada requisição.

Obs.4: O campo "complemento" é composto por um json no formato string contendo a informação obtida do campo "produtoIdParceiro" da operação anterior Consulta Valores StarBem.

Exemplo de REQUEST:

POST /venda/starbem/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjg3ODk1MTEwLCJleHAiOjE2ODc4OTU0MTAsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.kZ9oWPXjhWwKtOAqzufjxSxj-Ox2dTWoizQORfJi5KI
Host: sandbox.grupocard.com.br
Content-Length: 223

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","produto":"Psiquiatra","idExterno":"testeStarBemSV03","produtoIdParceiro":"4f32072b-8431-4b15-9528-8f91110f84bd","dataHoraCliente":"2023-06-27T15:45:00","valor":"11997"}

{
  "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
  "produto":"Psiquiatra",
  "idExterno":"testeStarBemSV03",
  "produtoIdParceiro":"4f32072b-8431-4b15-9528-8f91110f84bd",
  "dataHoraCliente":"2023-06-27T15:45:00",
  "valor":"11997"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "STARBEM PHARMA LTDA"
      }
    },
    "transacao": {
      "valor": 11997,
      "status": "AUTORIZADA",
      "instrucao": "{\"produto\":\"4f32072b-8431-4b15-9528-8f91110f84bd\",\"expired\":\"27/09/2023 19:45\",\"text\":\"Transacao autorizada.\",\"estabelecimentoId\":1191874,\"nsuParceiro\":\"9b355d42-769e-490e-982f-9ab01155bf82\",\"nomeEstabelecimento\":\"Homologacao Plataforma WS recarga Multiproduto - NAO MEXER\",\"valor\":11997,\"nsu\":\"65a4059a-e806-49ac-81e7-f06b416bb363\",\"dataHora\":\"2023-06-27T15:45:21-04:00\",\"message\":\"Transacao autorizada.\",\"situacaoAtual\":2,\"pin\":\"2392840971798511\"}",
      "complemento": "{\"produtoIdParceiro\":\"4f32072b-8431-4b15-9528-8f91110f84bd\"}",
      "idTransacao": "65a4059a-e806-49ac-81e7-f06b416bb363",
      "dataHora": "2023-06-27T15:45:21.000-04:00"
    },
    "idExterno": "testeStarBemSV03"
  }
}

2 - Consumir a operação Confirmar Venda

Utilize essa operação para efetivar/confirmar uma transação de venda solicitada anteriormente pela operação Solicitar Venda.

Obs. 1: A transação uma vez sendo Confirmada, seu status não poderá mais ser alterado, e mesmo que a operação seja invocada para tal ação, não surtirá efeito!

Exemplo de REQUEST:

POST /venda/starbem/confirmar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjg3ODk1MTEwLCJleHAiOjE2ODc4OTU0MTAsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.kZ9oWPXjhWwKtOAqzufjxSxj-Ox2dTWoizQORfJi5KI
Host: sandbox.grupocard.com.br
Content-Length: 170

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idTransacao":"65a4059a-e806-49ac-81e7-f06b416bb363","produto":"Psiquiatra","dataHoraCliente":"2023-06-27T15:45:00"}

{
  "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
  "idTransacao":"65a4059a-e806-49ac-81e7-f06b416bb363",
  "produto":"Psiquiatra",
  "dataHoraCliente":"2023-06-27T15:45:00"
}

Exemplo de RESPONSE:

{
  "transacao": {
    "status": "EFETIVADA",
    "idTransacao": "65a4059a-e806-49ac-81e7-f06b416bb363"
  }
}

Fluxo de cancelamento

1 - Consumir a operação Solicitar Venda:

Utilize essa operação para solicitar a venda de qualquer produto disponível no estabelecimento. Este serviço faz apenas a SOLICITAÇÃO da venda, portanto, se na resposta desta operação o campo "status" for igual a AUTORIZADA, na sequência a confirmação da transação deve ser enviada através da operação a seguir: Confirmar Venda

Obs. 1: Se ao invocar essa operação o cliente não obter uma resposta, é ALTAMENTE RECOMENDADO que seja realizado o cancelamentocancelamento da solicitação.

Obs. 2: A representação dos centavos no campo "valor" não deve ter separação por virgula e seu valor é obtido da operação anterior Consulta Valores StarBem do campo "valorProdutoParceiro". Ex: R$49,97 = 4997.

Obs.3: O campo "idExterno" é o identificador da requisição, sendo assim, deve ser enviado com um valor DIFERENTE a cada requisição.

Obs.4: O campo "complemento" é composto por um json no formato string contendo a informação obtida do campo "produtoIdParceiro" da operação anterior Consulta Valores StarBem.

Exemplo de REQUEST:

POST /venda/starbem/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjg3ODk1NDc5LCJleHAiOjE2ODc4OTU3NzksIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.An5AnkCv-1JL-eiC7La0jLRlo9bUbqbR_02uqL9iRLw
Host: sandbox.grupocard.com.br
Content-Length: 225

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","produto":"Clinico Geral","idExterno":"testeStarBemSV04","produtoIdParceiro":"2f37b079-d8aa-4928-8a50-049b1e7596d5","dataHoraCliente":"2023-06-27T15:51:00","valor":"4997"}

{
  "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
  "produto":"Clinico Geral",
  "idExterno":"testeStarBemSV04",
  "produtoIdParceiro":"2f37b079-d8aa-4928-8a50-049b1e7596d5",
  "dataHoraCliente":"2023-06-27T15:51:00",
  "valor":"4997"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "STARBEM PHARMA LTDA"
      }
    },
    "transacao": {
      "valor": 4997,
      "status": "AUTORIZADA",
      "instrucao": "{\"produto\":\"2f37b079-d8aa-4928-8a50-049b1e7596d5\",\"expired\":\"27/09/2023 19:52\",\"text\":\"Transacao autorizada.\",\"estabelecimentoId\":1191874,\"nsuParceiro\":\"d93fcb02-46cd-4523-8ca2-f7ce673105db\",\"nomeEstabelecimento\":\"Homologacao Plataforma WS recarga Multiproduto - NAO MEXER\",\"valor\":4997,\"nsu\":\"eadf03df-0ced-4468-9249-abfc0aac58bf\",\"dataHora\":\"2023-06-27T15:52:20-04:00\",\"message\":\"Transacao autorizada.\",\"situacaoAtual\":2,\"pin\":\"7310027855402350\"}",
      "complemento": "{\"produtoIdParceiro\":\"2f37b079-d8aa-4928-8a50-049b1e7596d5\"}",
      "idTransacao": "eadf03df-0ced-4468-9249-abfc0aac58bf",
      "dataHora": "2023-06-27T15:52:20.000-04:00"
    },
    "idExterno": "testeStarBemSV04"
  }
}

2 - Consumir a operação Cancelar Venda

Utilize essa operação para cancelar uma transação de venda solicitada anteriormente pela operação Solicitar Venda.

Obs. 1: A transação uma vez sendo Cancelada, seu status não poderá mais ser alterado, e mesmo que a operação seja invocada para tal ação, não surtirá efeito!

Exemplo de REQUEST:

POST /venda/starbem/confirmar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjg3ODk1NDc5LCJleHAiOjE2ODc4OTU3NzksIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.An5AnkCv-1JL-eiC7La0jLRlo9bUbqbR_02uqL9iRLw
Host: sandbox.grupocard.com.br
Content-Length: 173

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idTransacao":"eadf03df-0ced-4468-9249-abfc0aac58bf","produto":"Clinico Geral","dataHoraCliente":"2023-06-27T15:51:00"}

{
  "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
  "idTransacao":"eadf03df-0ced-4468-9249-abfc0aac58bf",
  "produto":"Clinico Geral",
  "dataHoraCliente":"2023-06-27T15:51:00"
}

Exemplo de RESPONSE:

{
  "transacao": {
    "status": "EFETIVADA",
    "idTransacao": "eadf03df-0ced-4468-9249-abfc0aac58bf"
  }
}