Guia

Paginação

Os endpoints de listagem paginam com um cursor opaco. Nunca calcula deslocamentos: segue o nextCursor até ele ser null. Os cursores mantêm-se estáveis perante escritas simultâneas, por isso nunca salta nem lê a mesma linha duas vezes.

O envelope de listagem

Uma resposta de listagem envolve as linhas em items e devolve um nextCursor. Quando nextCursor é null, chegou ao fim.

json

{  "items": [    { "id": "01J8ME9AZ2K3W7X4V5T6R7Q8S9", "amountCents": "-4250" },    { "id": "01J8ME9B1Q2W3E4R5T6Y7V8H9J", "amountCents": "-1899" }  ],  "nextCursor": "eyJjIjoiMjAyNi0wNi0yMlQxODowNDoxMS4xMjM0NTZaIiwiaSI6IjAxSjhNRTlCMVEyVzNFNFI1VDZZN1Y4SDlKIn0"}

Percorrer tudo

Passe o nextCursor anterior no parâmetro de query cursor para obter a página seguinte. Ajuste o tamanho da página com limit (com um máximo imposto pelo servidor).

bash

curl -H "Authorization: Bearer vokse_sk_…" \  "https://api.vokse.ai/households/current/transactions?limit=100"

bash

# pass the previous nextCursorcurl -H "Authorization: Bearer vokse_sk_…" \  "https://api.vokse.ai/households/current/transactions?limit=100&cursor=eyJjIjoiMjAyNi0wNi0yMlQxODowNDoxMS4xMjM0NTZaIiwiaSI6IjAxSjhNRTlCMVEyVzNFNFI1VDZZN1Y4SDlKIn0"

Bom saber

Os cursores são opacos. Não os interprete nem os construa manualmente.
Um cursor continua válido mesmo que entretanto sejam inseridas linhas novas; não salta nenhuma.
limit é um máximo; o servidor pode devolver menos linhas do que as pedidas.