Une API RESTful robuste et performante conçue spécifiquement pour les développeurs. Intégrez l'authentification par OTP, la publication d'annonces de location ou de vente, la gestion des profils utilisateur, le moteur de tarification des réservations et la passerelle de paiement en toute simplicité.
Conçue avec soin pour offrir la meilleure expérience de développement possible.
Inscription et connexion sans mot de passe via OTP (code à 6 chiffres) par email ou SMS, sécurisées par des jetons d'accès Bearer opaques hautement configurables.
Un ensemble complet de routes CRUD pour répertorier des biens immobiliers, avec des filtres complexes, le support de multiples images, et la gestion du statut des annonces.
Moteur de calcul de prix dynamique (Quote) et système robuste de vérification de disponibilité en temps réel pour éviter les sur-réservations de logements.
Initialisation et confirmation de transactions de paiement entièrement sécurisées pour monétiser ou réserver vos logements instantanément.
Organisation fine par Villes, Communes, et Quartiers pour localiser et trier précisément les annonces immobilières sur vos applications clientes.
Bâtie sur AdonisJS, dotée d'une validation de schéma stricte avec VineJS, d'une ORM sécurisée (Lucid), et d'une prise en charge native du typage TypeScript.
Voyez comment interagir avec l'API en quelques lignes de code.
# Récupérer les 2 dernières annonces d'appartements
curl -X GET "https://api.nyumba.ci/api/v1/annonces?limit=2" \
-H "Accept: application/json" \
-H "Authorization: Bearer oat_MTc2..."{
"data": [
{
"id": 104,
"title": "Magnifique Duplex F5 à Cocody",
"price": 850000,
"type": "location",
"ville": {
"id": 1,
"name": "Abidjan"
},
"commune": {
"id": 3,
"name": "Cocody"
},
"status": "publie"
}
]
}