Capítulo 3

Liberar version codes

  • É preciso cadastrar um “Range” das versões (version codes) do seu aplicativo. Sem esse passo, pode ocorrer erro de atestação na integração com a nossa SDK.

Requisitos

  • Credenciais CSO (Mais informações com o nosso suporte).
  • o packageName do seu aplicativo (Exemplo: com.zoop.sdk.taponphone.sample).
  • Postman ou Insomnia.

Configuração do novo token

  • Iremos utilizar o Postman nesse exemplo. O passo inicial é configurar um novo Token, para poder ter acesso aos endpoints corretamente.
  1. Acesse a aba de Authorization, e selecione o ‘Auth Type’ como OAuth 2.0
  2. Na opção de Configure new token, em Grant Type, selecione Client Credentials
  3. Em Access Token URL, insira https://login.microsoftonline.com/common/oauth2/v2.0/token
  4. Em Client ID, adicione o client id
  5. Em Client Secret, adicione o client secret
  6. Em Scope, insira https://mpplivece.onmicrosoft.com/625f88e3-3b1c-4209-a160-e06c1b7d0718/.default
  7. Em Client Authentication, selecione Send client credentials in body
  8. Após adicionar os parâmetros acima, clique em GET NEW ACCESS TOKEN.
  • Após gerar um token válido, você poderá utilizar os endpoints abaixo.

Utilizando a API

GET - Exibe versionCodes aceitos no Android Play Integrity do seu aplicativo.

  • Basta substituir o {packageName} pelo packageName do seu aplicativo:

https://api-na1.mypinpad.io/risk/policies/package/{packageName}/versions

Path parameters

  • packageName - string - obrigatório

Exemplo de resposta:

{
  "versionCodes": [
    1,
    2,
    3,
    4,
    5
  ]
}

Responses:

  • 200 OK
  • 400 Bad Request
  • 404 Not Found
  • 412 When version codes are present in multiple policies (this prevention from errors which could propagate due to manual edits in database)

PUT - Insere/Atualiza versionCodes aceitos na Android Play Integrity do seu aplicativo.

  • Você precisa fornecer o versionCode atual do seu aplicativo, e adicionar um “range” para ele.
  • Por exemplo, se seu aplicativo encontra-se no versionCode 1, você pode acrescentar um range de 1-50.
  • Não há um limite de range. Você pode determinar o range que quiser.
  • Basta substituir o {packageName} pelo packageName do seu aplicativo.

https://api-na1.mypinpad.io/risk/policies/package/{packageName}/versions

Path parameters

  • packageName - string - obrigatório

Body

  • versionCodes - integer · int64[] | nullable - obrigatório

No body da request, Selecione a opção raw, e insira o JSON como no exemplo a seguir:

{
    "versionCodes": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10
    ]
}

Responses:

  • 204 No content
  • 400 Bad Request
  • 404 Not Found
  • 412 When version codes are present in multiple policies (this prevention from errors which could propagate due to manual edits in database)

PUT - Insere versionCode aceito na Android Play Integrity do seu aplicativo.

  • Basta substituir o {packageName} pelo packageName do seu aplicativo.
  • Basta substituir o {version} pelo versionCode do seu aplicativo.

Path parameters

  • packageName - string - obrigatório
  • version - integer · int64 - obrigatório

https://api-na1.mypinpad.io/risk/policies/package/{packageName}/version/{version}

Responses:

  • 204 No content
  • 400 Bad Request
  • 404 Not Found
  • 412 When version codes are present in multiple policies (this prevention from errors which could propagate due to manual edits in database)

DELETE - Remove versionCode aceito na Android Play Integrity do seu aplicativo.

  • Basta substituir o {packageName} pelo packageName do seu aplicativo.
  • Basta substituir o {version} pelo versionCode do seu aplicativo.

Path parameters

  • packageName - string - obrigatório
  • version - integer · int64 - obrigatório

https://api-na1.mypinpad.io/risk/policies/package/{packageName}/version/{version}

Responses:

  • 204 No content
  • 400 Bad Request
  • 404 Not Found
  • 412 When version codes are present in multiple policies (this prevention from errors which could propagate due to manual edits in database)

Collection de exemplo

  • Disponibilizamos abaixo uma collection de exemplo, com alguns parãmetros pré-configurados, para auxiliar na utilização da API, bastando apenas inserir suas credenciais CSO, em CLIENT ID e CLIENT SECRET.