Estaci.one Integration API
    Estaci.one Integration API
    • Fluxo de uso da API de Integração
    • OAuth
      • Recuperar token
        POST
    • Ticket
      • Emissão de ticket
        POST
      • Parse QrCode
        POST
      • Validação do ticket para uma loja
        POST
      • Adicionar transação ao ticket
        POST
    • Schemas
      • Money
      • Vehicle Details
      • Ticket Details
      • Provider Basic
      • Totem Basic
      • Transaction Details
      • 422
      • 400

    Fluxo de uso da API de Integração

    Estaci.one - Integração#

    Ordem de execução:#

    Recuperar token de acesso
    Criação de um ticket (Opcional: apenas se não tiver totem de entrada)
    Parse QrCode para recuperar o ticketNumber
    Validação do ticket através de um location
    Adicionar um transação ao ticket (Opcional: apenas se for utilizar o pagamento de valores restante fora do painel do usuário)
    Obs.: A liberação do ticket é feita de forma automática quando não tem mais valores pendentes.#


    Fluxo de autenticação#

    Executar o endpoint de recuperação do token de acesso, utilizando o clientId e clientSecret fornecidos.

    Exemplo do payload#

    {
        "grant_type": "client_credentials",
        "client_id": "0196efa4-e6a3-72f7-8877-efb5072a8cf7",
        "client_secret": "RyesUIE1FahezOGIQ8A4cEfqMn37QyU6jpb4bmRy",
        "scope": "*"
    }
    Será então retornado, se estiver corretos e válidos os acessos, o token de acesso junto com a validade e o tipo de token (por padrão Bearer).
    {
        "token_type": "Bearer",
        "expires_in": 28799,
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIwMTk2ZWYxNC1lYTBjLTcyMjYtYmM1Yy0zNjRmNjJmOTQ2ZTciLCJqdGkiOiI2YjQ1N2VlMjY0NzMwNDIxNjQxYTQ4YWQ5ZGFlNDNiMjc5YmU2M2E4ODEwZmEzYzEwZjQyZmQ3ZWJmMjA1YjJjOWM2ZDM3OTY5YzllNWRmYyIsImlhdCI6MTc0Nzc5MTU1NS4wMTc5MTcsIm5iZiI6MTc0Nzc5MTU1NS4wMTc5MjEsImV4cCI6MTc0NzgyMDM1NC45NTkwNDcsInN1YiI6Ijc2NTQ4Mjk1ODE2MDQwNDQ4MCIsInNjb3BlcyI6WyIqIl19.hRB7tIJP3mEiSsPo17gawndwqVpiNT72BqVFWdhBmsCFW3_CEneLVNR5i9_kxHcVnLH0jt97DkScYu6D6ayYG6nPhR3lUEVs4G-DUBqTik_6uqa0kD58VbzwZDCG8T_cFs-mQa1bVHnY6y4PtNSFeqvjgOUT0cGb7cTCL7Sk-qg5YIjN0EuyVa689wk7xr-PqV3XkEQlmSEQiLD4NCPDh5b7mbHulIfh-PFUfXHg5t9Ar5ABAj4HKQY7yNG63JxivcRu6Ea20DpyJRMQNvTACwejwGi-YIhmmDzBr0YASZg5w6kb1JSolkFcVzrfCiNbMHPLyJVE9Vqeu1nl8Ha_0V1Ky_l6LhhxRl9X2tMBh9UU23SgwpBYvTI1wV98OrKwVcqnONJDWoKDoMwsmCqEP4ecctPleIsQ3g-RrzVwQJ6dLy84Evtq1VR51iH3EGu4Ssu3XOmW4z8--pUgxAsLFKYjlJnDFueHfcrUYipg8VBotULNHEyeeW6CurIlhXHaLV3cS9RUi9CYSJh9oDm9_zxkoUV3NLD31YkssisJXPXjlWoHSCVdvIyLOgR-Qe4hgkxBbZRpPJbtD9Fq3RKXqP-cpe3n4ovbQuY5iWWd4bvOYDSVTFf7xI0Yf2dbONzOk2f0Ae8Yqjh309Ihfr0cjmEIwIsGT9p4bAdA4rM4i1M"
    }
    Com o access_token agora é possível utilizar os demais endpoints.
    Lembre sempre de verificar se o token de acesso não está expirado antes da requisição.


    Parse QrCode#

    O parse do QrCode permite obter o número do ticket que será utilizado nos demais endpoints.
    Nele é passado o conteúdo do QrCode como payload:
    {
        "qrCode": "AQgKn4qx0QQgAAIICp-Ksi1ABPEDBGgs0icAEOtLObuq_ZjuXTRoi1MsOHE"
    }
    e então, em caso de sucesso, é retornado os dados do ticket:
    {
      "ticketNumber": "765482959544255729",
      "checkIn": "2025-05-20T19:04:07.000000Z"
    }


    Validação do ticket para uma loja#

    A validação do ticket para uma loja tem o objetivo de validar o ticket com o valor de compra, utilizando o identificador de uma loja (locationId), desta forma consegue se obter descontos ou isenção, de acordo com a regra da loja.
    {
        "locationId": "765482959250923520",
        "purchaseAmount": 9105765,
        "receiptNumber": "97"
    }
    O retorno contém os detalhes do ticket, caso o atributo release não estiver nulo, então o ticket foi liberado e a data e hora limite para saída esta em release.releaseValidUntil, caso não tenha sido liberado, então tem um valor pendente que se encontra em amountToPay.amount, sendo este valor em centavos.


    Para código de erros e outras dúvidas, consulte os endpoint correspondentes na documentação.#
    Modified at 2025-06-02 17:46:05
    Next
    OAuth
    Built with