Een aanvraag opbouwen

De aanvraag

GET https://app.apiboard.nl/api/v1/<koppeling>/<tabel>
Authorization: Bearer apib_live_JOUW_SLEUTEL

<koppeling> en <tabel> zijn de namen uit de referentie per koppeling, bijvoorbeeld /api/v1/wefact/facturen. Een onbekende combinatie geeft 404 unknown_table.

Parameters

Een van deze parameters mag maar één keer voorkomen. Staat er in je aanvraag iets anders dan deze parameters, dan leest de API het als een filter op een kolom. Bestaat die kolom niet, dan krijg je een 400; de API negeert nooit stilzwijgend iets.

Filteren op kolommen

Elke kolom van de tabel kun je als filter gebruiken. Je kunt filters combineren (alle filters moeten kloppen), tot maximaal 10 per aanvraag.

• ?status=4 is een gelijkheidsfilter (bij WeFact is 4 de statuscode voor Betaald; de codes per kolom staan in de referentie).
• ?kolom[operator]=waarde kiest een andere operator: eq, ne, gt, gte, lt, lte of in.
• gt, gte, lt en lte werken alleen op kolommen van het type numeriek, geheel getal, datum of tijdstip.
• in neemt 1 tot en met 50 waarden gescheiden door komma’s, bijvoorbeeld ?status[in]=2,3. Staat er een komma in de waarde zelf, schrijf dan \,.
• Dezelfde combinatie van kolom en operator mag maar één keer voorkomen.

Een onbekende kolom, een operator die niet bij het kolomtype past of een waarde die niet bij de kolom past geeft 400 invalid_filter.

Voorbeeld met een filter op meerdere waarden:

GET https://app.apiboard.nl/api/v1/wefact/facturen?status%5Bin%5D=2%2C3&limit=100 HTTP/1.1
Host: app.apiboard.nl
Authorization: Bearer apib_live_JOUW_SLEUTEL

curl -H "Authorization: Bearer apib_live_JOUW_SLEUTEL" \
  "https://app.apiboard.nl/api/v1/wefact/facturen?status%5Bin%5D=2%2C3&limit=100"

import requests

TOKEN = "apib_live_JOUW_SLEUTEL"
URL = "https://app.apiboard.nl/api/v1/wefact/facturen"

resp = requests.get(URL, params={"status[in]": "2,3", "limit": 100}, headers={"Authorization": f"Bearer {TOKEN}"})
resp.raise_for_status()
body = resp.json()

for rij in body["data"]:
    print(rij)
print("Volgende pagina:", body["next_cursor"])

let
    Basis = "https://app.apiboard.nl",
    Pad = "/api/v1/wefact/facturen",
    Token = "apib_live_JOUW_SLEUTEL",
    Filters = [#"status[in]" = "2,3", limit = "100"],

    HaalPaginaOp = (cursor as nullable text) =>
        Json.Document(Web.Contents(Basis, [
            RelativePath = Pad,
            Query = if cursor = null then Filters else Record.AddField(Filters, "cursor", cursor),
            Headers = [Authorization = "Bearer " & Token]
        ])),

    // Volg next_cursor tot die null is; de pagina met next_cursor = null telt ook mee.
    Paginas = List.Generate(
        () => HaalPaginaOp(null),
        each _ <> null,
        each if [next_cursor] = null then null else HaalPaginaOp([next_cursor]),
        each [data]
    ),

    AlleRijen = List.Combine(Paginas),
    Tabel = if List.IsEmpty(AlleRijen)
        then #table({"id", "synced_at"}, {})
        else Table.FromRecords(AlleRijen, null, MissingField.UseNull),
    // Dedupliceer op id: eerst de nieuwste versie bovenaan, dan houdt Distinct die.
    // Verwijder daarna rijen die bij de bron verwijderd zijn.
    NieuwsteEerst = Table.Buffer(Table.Sort(Tabel, {{"synced_at", Order.Descending}})),
    ZonderDubbel = Table.Distinct(NieuwsteEerst, {"id"}),
    ZonderVerwijderd = Table.SelectRows(ZonderDubbel, each Record.FieldOrDefault(_, "bron_verwijderd_op", null) = null)
in
    ZonderVerwijderd

Het antwoord

Rechts staat een voorbeeld van een aanvraag met bijbehorend antwoord. Het antwoord heeft deze vorm:

Elk antwoord bevat ook de headers X-RateLimit-Remaining en X-RateLimit-Remaining-Day, zie Gebruikslimieten.

Heeft een koppeling kind-tabellen (bijvoorbeeld factuurregels onder facturen), dan staat op de referentiepagina van die tabel via welke kolom je ze aan de bovenliggende tabel koppelt.

Onze tip: rijen kunnen tijdens het ophalen van pagina’s wijzigen en daardoor twee keer voorkomen. Dedupliceer in je eigen verwerking op id en houd de versie met de nieuwste synced_at.