elefymove
Documentación

Documentación para desarrolladores

Guías y referencia de la Open API de ElefyMove.

Estas guías están disponibles actualmente solo en inglés.

Create a developer account

Sign up at the developer portal, verify your email address, and sign in. A developer account is free and separate from any ElefyMove renter or landlord account.

Create an API client

From the dashboard, create an API client. Every client created in this portal is a test client — the full API key (an efy_test_… token) is shown exactly once at creation — copy it immediately and store it in a secret manager. If you lose it, rotate the key from the dashboard; the old key stops working right away. Each account can hold up to 5 API clients.

Test mode

A test key works the moment it is created. It is the fastest way to build and verify your integration end to end before anything touches the live marketplace. What test mode does, honestly:

  • Listings created with a test key are sandbox listings: they go through exactly the same input validation and photo processing as live listings, but they never appear on elefymove.com — not in search, not on property pages, not in sitemaps — and they are never published.
  • Webhook deliveries to a test client carry "livemode": false in the payload envelope, so your handler can always tell the two apart.
  • Sandbox listings not updated for 30 days are deleted automatically — treat test data as disposable.

The API surface is identical in both environments — only the key changes. Test data never migrates to live; recreate your listings with the live key once you have one.

Going live

Live keys are not issued by this portal. A live key (an efy_live_… token) is created by the landlord inside the ElefyMove back office and belongs to that landlord's account from the moment it is created. To take an integration live, the landlord you build for creates the key under Settings → API keys and hands it to you securely; it works immediately, with no separate approval step.

Make your first call

Verify your key with the ping endpoint — it echoes the client name and scopes attached to the key:

curl "https://elefymove.com/api/public/v1/ping" \
  -H "X-Api-Key: efy_live_xxxxxxxxxxxxxxxxxxxxxxxx"

# Response — 200 OK
{ "ok": true, "client": "My booking site", "scopes": ["listings:read", "availability:read"] }

The base URL for every request is https://elefymove.com. Every endpoint's request and response shape is documented in the topic pages of this documentation — use the sidebar to jump to Listings, Availability & Holds, Webhooks, or iCal.

Next steps