Dokumentacja Provider API

Pierwsze kroki

JSON przez HTTPS. Wyślij jedno wywołanie na klienta, gdy zmieni się jego przełącznik. Każde wywołanie można bezpiecznie powtórzyć.

Adres bazowyhttps://api.anuto.app/v1

Endpointy

Ponawianie jest bezpieczne

Wywołania z tym samym externalId aktualizują tego klienta. Nigdy nie tworzą duplikatów, więc możesz ponowić po przekroczeniu czasu.

Uwierzytelnianie

Wysyłaj klucz w nagłówku Authorization w każdym żądaniu. Klucze zaczynają się od anp_, są pokazywane tylko raz i można je zmienić na stronie kluczy API.

Authorization: Bearer anp_…

Aktywuj lub zaktualizuj klienta

POST/provider/clients

Wyślij dane klienta, gdy jego przełącznik się włączy. Powtórzenie wywołania z tym samym externalId aktualizuje tego klienta.

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
  }'

Odpowiedź

Każde wywołanie zwraca status klienta, liczbę ogłoszeń i pakiet.

{
  "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"
}

Sprawdzanie statusu klienta

GET/provider/clients/{externalId}

Zwraca bieżący status klienta, liczbę ogłoszeń i plan, w tym samym formacie co odpowiedź po aktywacji.

curl https://api.anuto.app/v1/provider/clients/12345 \
  -H "Authorization: Bearer $ANUTO_KEY"

Dezaktywuj klienta

DELETE/provider/clients/{externalId}

Usunięcie klienta wyłącza go i wycofuje jego ogłoszenia z Anuto.

curl -X DELETE https://api.anuto.app/v1/provider/clients/12345 \
  -H "Authorization: Bearer $ANUTO_KEY"

Zgłaszanie zmian

POST/provider/clients/{externalId}/changes

Wywołuj je zawsze, gdy zmieniają się zapasy klienta: ogłoszenie zostaje dodane, zmienione, sprzedane lub usunięte. Synchronizujemy tego klienta w ciągu kilku minut, zamiast czekać na regularną synchronizację co kilka godzin. Wywołania w ciągu 5 minut są łączone, więc można wywoływać je przy każdej zmianie.

• Treść żądania jest opcjonalna. Dodaj itemIds, aby wskazać do 100 identyfikatorów zmienionych nieruchomości lub produktów.
• Udane wywołanie zwraca 202. nextSyncAt to czas (UTC), na który zaplanowano ponowną synchronizację.
• W przypadku nieaktywnego klienta odpowiedź zawiera queued: false i komunikat. Nic nie trafia do kolejki.

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"
}

Sprawdzanie klucza

GET/provider/me

Zwraca nazwę Twojego dostawcy, formaty objęte Twoim dostępem i status klucza. Wywołaj to najpierw, aby sprawdzić, czy nowy klucz działa.

curl https://api.anuto.app/v1/provider/me \
  -H "Authorization: Bearer $ANUTO_KEY"

{
  "providerId": "Xw3kQ9mZr2LpT7vNa4Bc",
  "name": "Your software company",
  "formats": ["…"],
  "status": "approved"
}

Tryb testowy

Ustaw test na true, aby zwalidować dane i sprawdzić połączenie. Nic nie jest tworzone: dostajesz status, jaki by został nadany, oraz wyniki sprawdzeń.

{
  "externalId": "12345",
  "name": "Casa Sol Real Estate",
  "email": "[email protected]",
  "country": "ES",
  "test": true
}

{
  "ok": true,
  "wouldBe": "active",
  "checks": { "connection": "ok", "owner": "new_account" }
}

Statusy klienta

• activeAktywny i zsynchronizowany.
• pendingPołączenie jeszcze nie działa, więc nic nie jest publikowane.
• reviewAnuto to sprawdza, bo e-mail tego nowego klienta należy już do innego konta Anuto.
• inactiveWyłączony przez Ciebie lub usunięty przez Anuto.

Błędy

Nieudane wywołania zwracają JSON ze statusCode, code i message. Reaguj na code; message jest dla ludzi.

{
  "statusCode": 404,
  "code": "PROVIDER_CLIENT_NOT_FOUND",
  "message": "No client with externalId 12345"
}

Limity żądań

Po przekroczeniu limitu dostajesz 429 z nagłówkiem Retry-After. Poczekaj tyle sekund i ponów próbę.