Provider API-documentatie
Elk eindpunt, veld, antwoord en fout op één pagina. Voorbeelden gebruiken curl en JSON.
Aan de slag
JSON via HTTPS. Stuur per klant één aanroep wanneer de schakelaar verandert. Elke aanroep kan veilig worden herhaald.
Basis-URLhttps://api.anuto.app/v1
Endpoints
| Endpoint | Betekenis |
|---|---|
POST/provider/clients | Een klant activeren of bijwerken |
GET/provider/clients/{externalId} | Status van één klant |
DELETE/provider/clients/{externalId} | Een klant deactiveren en de advertenties intrekken |
POST/provider/clients/{externalId}/changes | Anuto laten weten dat de voorraad van een klant is veranderd |
GET/provider/me | De sleutel controleren: providernaam, formaten en status |
Opnieuw proberen is veilig
Aanroepen met dezelfde externalId werken die klant bij. Ze maken nooit dubbele gegevens aan, dus je kunt na een time-out opnieuw proberen.
Authenticatie
Stuur je sleutel bij elk verzoek in de Authorization-header. Sleutels beginnen met anp_, worden maar één keer getoond en kunnen op de pagina API-sleutels worden vervangen.
Authorization: Bearer anp_…Een klant activeren of bijwerken
POST/provider/clients
Stuur de gegevens van de klant wanneer de schakelaar aangaat. Herhaal de aanroep met dezelfde externalId om die klant bij te werken.
curl -X POST https://api.anuto.app/v1/provider/clients \
-H "Authorization: Bearer $ANUTO_KEY" \
-H "Content-Type: application/json" \
-d '{
"externalId": "12345",
"name": "Casa Sol Real Estate",
"email": "[email protected]",
"phone": "+34 600 000 000",
"website": "https://casasol.es",
"country": "ES",
"listingsCount": 85
}'| Veld | Verplicht | Betekenis |
|---|---|---|
externalId | Verplicht | Je ID voor deze klant (bijvoorbeeld het account- of bedrijfs-ID in je software). 1 tot 100 tekens. |
name | Verplicht | Bedrijfsnaam (maximaal 120 tekens). |
email | Verplicht | Contact-e-mail van de klant. Wordt gebruikt om het Anuto-account aan te maken als de klant nieuw is bij Anuto. |
country | Verplicht | Tweeletterige ISO-landcode, bijvoorbeeld ES. |
phone | Optioneel | Contacttelefoon (maximaal 40 tekens). |
website | Optioneel | Website van de klant, http of https. |
format | Optioneel | Alleen nodig als je toegang meerdere integraties omvat. |
connection | Optioneel | Verbindingsvelden voor je integratie, indien nodig. Welke dat zijn, laten we je weten bij de goedkeuring van je toegang. |
listingsCount | Optioneel | Aantal advertenties van de klant, voor planning. |
test | Optioneel | Alleen valideren en de verbinding controleren. Er wordt niets aangemaakt. |
Antwoord
Elke aanroep geeft de status van de klant, het aantal advertenties en het abonnement terug.
{
"externalId": "12345",
"clientId": "Xw3kQ9mZr2LpT7vNa4Bc",
"status": "active",
"shopUrl": "https://es.anuto.app/@casa-sol",
"listings": { "active": 10, "waiting": 0, "planWaiting": 75 },
"plan": { "tier": "free", "maxActive": 10, "freeMaxActive": 10 },
"upgradeUrl": "https://es.anuto.app/user/manage/plan",
"lastSyncAt": "2026-10-08T09:30:00.000Z"
}De status van een klant opvragen
GET/provider/clients/{externalId}
Geeft de huidige status van de klant, het aantal advertenties en het abonnement terug, in dezelfde vorm als het antwoord bij activeren.
curl https://api.anuto.app/v1/provider/clients/12345 \
-H "Authorization: Bearer $ANUTO_KEY"Een klant deactiveren
DELETE/provider/clients/{externalId}
Een klant verwijderen zet hem uit en trekt zijn advertenties van Anuto in.
curl -X DELETE https://api.anuto.app/v1/provider/clients/12345 \
-H "Authorization: Bearer $ANUTO_KEY"Wijzigingen melden
POST/provider/clients/{externalId}/changes
Roep dit aan wanneer de voorraad van een klant verandert: een advertentie wordt aangemaakt, bijgewerkt, verkocht of verwijderd. We synchroniseren die klant binnen enkele minuten, in plaats van te wachten op de reguliere synchronisatie elke paar uur. Aanroepen binnen 5 minuten worden samengevoegd, dus je kunt het bij elke wijziging aanroepen.
- De body is optioneel. Voeg itemIds toe om maximaal 100 van je woning- of product-ID's te noemen die zijn gewijzigd.
- Een geslaagde aanroep geeft 202 terug. nextSyncAt is het tijdstip (UTC) waarop de hersynchronisatie gepland staat.
- Bij een inactieve klant bevat het antwoord queued: false en een bericht. Er wordt niets in de wachtrij gezet.
curl -X POST https://api.anuto.app/v1/provider/clients/12345/changes \
-H "Authorization: Bearer $ANUTO_KEY" \
-H "Content-Type: application/json" \
-d '{ "itemIds": ["123", "456"] }'{
"queued": true,
"nextSyncAt": "2026-10-08T12:00:00Z"
}Je sleutel controleren
GET/provider/me
Geeft de naam van je aanbieder, de formaten die je toegang dekt en de status van de sleutel terug. Roep dit eerst aan om te controleren of een nieuwe sleutel werkt.
curl https://api.anuto.app/v1/provider/me \
-H "Authorization: Bearer $ANUTO_KEY"{
"providerId": "Xw3kQ9mZr2LpT7vNa4Bc",
"name": "Your software company",
"formats": ["…"],
"status": "approved"
}Testmodus
Zet test op true om de gegevens te valideren en de verbinding te controleren. Er wordt niets aangemaakt: je krijgt de status die het zou krijgen en de resultaten van de controles.
{
"externalId": "12345",
"name": "Casa Sol Real Estate",
"email": "[email protected]",
"country": "ES",
"test": true
}
{
"ok": true,
"wouldBe": "active",
"checks": { "connection": "ok", "owner": "new_account" }
}Klantstatussen
- activeLive en synchroniseert.
- pendingDe verbinding werkt nog niet, dus er wordt niets gepubliceerd.
- reviewAnuto bekijkt het, omdat het e-mailadres van deze nieuwe klant al bij een ander Anuto-account hoort.
- inactiveDoor jou uitgezet of door Anuto verwijderd.
Fouten
Mislukte aanroepen geven JSON terug met statusCode, code en message. Reageer op code; message is voor mensen.
{
"statusCode": 404,
"code": "PROVIDER_CLIENT_NOT_FOUND",
"message": "No client with externalId 12345"
}| Code | HTTP | Betekenis |
|---|---|---|
PROVIDER_KEY_INVALID | 401 | Sleutel ontbreekt, is onjuist of onbekend. |
PROVIDER_REVOKED | 403 | Je providertoegang is door Anuto ingetrokken. |
PROVIDER_FORMAT_REQUIRED | 400 | Je software heeft meerdere formaten, dus de body heeft format nodig. |
PROVIDER_FORMAT_NOT_ALLOWED | 400 | Het formaat hoort niet bij je goedgekeurde formaten. |
PROVIDER_CLIENT_NOT_FOUND | 404 | Geen klant met die externalId bij jouw provider. |
Limieten voor aanroepen
Bij overschrijding krijg je 429 met een Retry-After-header. Wacht zoveel seconden en probeer het opnieuw.
Vragen over de API of je toegang? [email protected]