ImmoWP Estimation vs API Bearer Auth

The API Bearer Auth plugin enables authentication for the REST API by using JWT access an refresh tokens. After the user logs in, the access and refresh tokens are returned and can be used for the next requests. Issued tokens can be revoked from within the users admin screen. See below for the endpoints. Note that after activating this plugin, all REST API endpoints will need to be authenticated, unless the endpoint is whitelisted in the api_bearer_auth_unauthenticated_urls filter (see FAQ for how to use this filter). JWT Access tokens can be formatted as JWT tokens. For this to work, you first have to create a secret and add it to the wp-config.php file. If you don’t do this, access tokens will work also, but are just random strings. To create a random secret key, you can do for example: base64_encode(openssl_random_pseudo_bytes(64)); And then add the result to wp-config: define('API_BEARER_JWT_SECRET', 'mysecretkey'); If you have problems, you can verify your JWT tokens at: https://jwt.io/ Revoke tokens This plugin adds a column to the users table in de admin where you can see when a token expires. You can also revoke tokens by selection the “Revoke API tokens” from the bulk actions select box. API endpoints Note that all endpoints expect JSON in the POST body. Login Endpoint: POST /api-bearer-auth/v1/login Request body: Note: client_name is optional. But if you use it, make sure to use it as well for the refresh call! {"username": "my_username", "password": "my_password", "client_name": "my_app"} Response: { "wp_user": { "data": { "ID": 1, "user_login": "your_user_login", // other default WordPress user fields } }, "access_token": "your_access_token", "expires_in": 86400, // number of seconds "refresh_token": "your_refresh_token" } Make sure to save the access and refresh token! Refresh access token Endpoint: POST /api-bearer-auth/v1/tokens/refresh Request body: Note: client_name is optional. But if you did use it for the login call, make sure to use it here as well! {"token": "your_refresh_token", "client_name": "my_app"} Response success: { "access_token": "your_new_access_token", "expires_in": 86400 } Response when sending a wrong refresh token is a 401: { "code": "api_api_bearer_auth_error_invalid_token", "message": "Invalid token.", "data": { "status": 401 } } Do a request After you have the access token, you can make requests to authenticated endpoints with an Authorization header like this: Authorization: Bearer Note that Apache sometimes strips out the Authorization header. If this is the case, make sure to add this to the .htaccess file: RewriteCond %{HTTP:Authorization} ^(.*) # Don't know why, but some need the line below instead of the RewriteRule line # SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0 RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1] If you are not logged in or you send an invalid access token, you get a 401 response: { "code": "api_bearer_auth_not_logged_in", "message": "You are not logged in.", "data": { "status": 401 } } Important update Update immediately if you’re using a version below 20200807. Before this version all access tokens were updated when calling the refresh callback. If you are affected by this the fastest solution is to execute this query: update wp_user_tokens set access_token_valid = NOW(); This will invalidate all access tokens. This means that all users need to refresh their access token and will get a new access token and a unique one this time. A big thank to @harchvertelol for reporting this and suggesting the fix as well!

ImmoWP Estimation est un plugin WordPress complet qui fournit un formulaire professionnel multi-etapes pour l’estimation de biens immobiliers. Parfait pour les agences immobilieres, les societes de gestion immobiliere et les agents independants. Fonctionnalites principales Formulaire interactif en 6 etapes – Assistant multi-pages convivial avec barre de progression Autocompletion d’adresse – Integration avec l’API gouvernementale francaise (api-adresse.data.gouv.fr) Support API externe – Connectez votre propre API d’estimation Mode de secours – Fonctionne meme sans configuration API Securite : Integration Google reCAPTCHA v3 Limitation de requetes par IP Verification de nonce Validation et assainissement des entrees Notifications par email – Emails automatiques aux utilisateurs et administrateurs Administration : Tableau de bord detaille des estimations Filtres avances (statut, type de bien) Recherche etendue Export CSV Meta box en lecture seule avec notes admin Performance optimisee : Mise en cache de l’API d’adresses Index de base de donnees Chargement conditionnel des assets Accessibilite – Attributs ARIA et conformite WCAG AA Fonctionnement L’utilisateur remplit le formulaire en 6 etapes : Selection de l’adresse avec autocompletion Type de bien (maison/appartement) Surface habitable et terrain Nombre de pieces Etat du bien Coordonnees La soumission declenche : Appel API pour l’estimation (si configure) OU message de secours pour rappel Notifications email a l’utilisateur et l’admin Stockage des donnees dans WordPress Les administrateurs peuvent : Voir toutes les demandes d’estimation Filtrer et rechercher les soumissions Exporter les donnees en CSV Ajouter des notes internes Shortcode Ajoutez simplement [immowp_estimation_form] a n’importe quelle page ou article. Integration API Le plugin peut se connecter a n’importe quel point de terminaison API REST qui accepte les donnees du bien et retourne les valeurs d’estimation. Voir la documentation pour les specifications API. Confidentialite & RGPD Les donnees utilisateur sont stockees localement dans votre base WordPress Aucune donnee n’est envoyee a des tiers (sauf votre API configuree) Les administrateurs peuvent supprimer les soumissions a tout moment Foire Aux Questions Ai-je besoin d’une API externe ? Non ! Le plugin fonctionne en “mode de secours” sans API. Dans ce mode, les soumissions sont enregistrees et vous recevez une notification par email pour contacter l’utilisateur. Puis-je personnaliser le message de confirmation ? Oui ! Allez dans Estimations > Reglages, puis dans la section “Parametres avances”, vous pouvez personnaliser le “Message en mode fallback” affiche aux utilisateurs quand l’API n’est pas configuree. Comment configurer reCAPTCHA ? Obtenez vos cles reCAPTCHA v3 sur https://www.google.com/recaptcha/admin Dans WordPress, allez dans Estimations > Reglages Dans la section “Google reCAPTCHA v3”, cochez “Activer la verification reCAPTCHA v3” Entrez votre Site Key et Secret Key Ajustez le seuil de score si necessaire (defaut 0.5) Cliquez sur “Enregistrer les parametres” Puis-je exporter les demandes d’estimation ? Oui ! Allez sur la page admin Estimations et cliquez sur “Exporter CSV”. L’export respecte vos filtres actuels. Le formulaire est-il adapte au mobile ? Oui ! Le formulaire est entierement responsive et fonctionne parfaitement sur tous les appareils. Puis-je traduire le plugin ? Oui ! Le plugin est pret pour la traduction avec le domaine de texte immowp-estimation. Utilisez Loco Translate ou des outils similaires. Ou trouver les reglages du plugin ? Le menu principal “Estimations” apparait dans la barre laterale de l’administration WordPress apres activation du plugin. Les reglages se trouvent dans : Estimations > Reglages. Testing Test rapide du plugin Pour tester rapidement le plugin sur une installation WordPress fraiche : Installer et activer : Telechargez et activez le plugin Verifier le menu : Le menu “Estimations” apparait dans la barre laterale admin Creer une page de test : Allez dans Pages > Ajouter Titre : “Test Estimation” Contenu : [immowp_estimation_form] Publiez la page Tester le formulaire : Visitez la page publiee Le formulaire d’estimation en 6 etapes s’affiche Etape 1 : Tapez “Paris” dans le champ adresse – des suggestions apparaissent Selectionnez une adresse dans la liste Continuez a travers les 6 etapes (type, surface, pieces, etat, contact) Soumettez le formulaire Verifier l’enregistrement : Allez dans Estimations > Toutes les estimations La demande soumise apparait dans la liste Cliquez dessus pour voir les details complets Fonctionnalites a tester Autocompletion d’adresse : Tapez au moins 3 caracteres pour voir les suggestions Navigation multi-etapes : Utilisez les boutons Precedent/Suivant Validation des champs : Essayez de soumettre avec des champs vides Responsive : Testez sur mobile et desktop Admin : Filtrez par statut, recherchez par email, exportez en CSV Mode fallback : Sans API configuree, un message de rappel s’affiche Captures d’ecran Formulaire d’estimation moderne en 6 etapes avec barre de progression Autocompletion d’adresse avec integration API francaise Collecte des details du bien Tableau de bord admin avec filtres et recherche Page de reglages avec toutes les options de configuration Meta box des details d’estimation avec informations en lecture seule Documentation API Format de requete Votre API doit accepter des requetes POST a {base_url}/api/estimate avec la structure JSON suivante : { "codeCommune": "75001", "surfaceHabitable": 75, "typeLocal": "appartement", "codePostal": "75001", "surfaceTerrain": 0, "voie": "Rue de Rivoli", "numeroVoie": "10" } Reponse attendue { "estimatedPrice": 450000, "estimatedPriceMin": 420000, "estimatedPriceMax": 480000, "confidence": "high", "status": "success" } Voir la documentation complete sur https://immowp.com/docs/api Support Pour le support, les demandes de fonctionnalites ou les rapports de bugs, veuillez utiliser les forums de support WordPress.org. External Services This plugin connects to external third-party services to provide its functionality. Below is detailed information about each service: French National Address API (Base Adresse Nationale) This plugin uses the French government’s address API to provide address autocomplete functionality in the estimation form. What it does: Provides address suggestions when users type in the address field Data sent: The text entered by the user in the address search field When data is sent: Each time the user types at least 3 characters in the address field Service provider: French government (Etalab/DINUM) Service URL: https://api-adresse.data.gouv.fr/search/ Terms of service: https://adresse.data.gouv.fr/cgu Privacy policy: https://adresse.data.gouv.fr/donnees-personnelles Google reCAPTCHA v3 (Optional) If enabled in the plugin settings, this plugin uses Google reCAPTCHA v3 to protect the form against spam and automated submissions. What it does: Validates that form submissions come from real users, not bots Data sent: User’s IP address, reCAPTCHA token, and browser information When data is sent: When the user submits the estimation form (if reCAPTCHA is enabled) Service provider: Google LLC Service URL: https://www.google.com/recaptcha/api/siteverify Terms of service: https://policies.google.com/terms Privacy policy: https://policies.google.com/privacy Your Configured Estimation API (Optional) If you configure an external estimation API in the plugin settings, the plugin will send property data to calculate real estate valuations. What it does: Calculates property estimation based on submitted data Data sent: Property details (address, type, surface area, number of rooms, condition) When data is sent: When the user submits a complete estimation form Service provider: Configured by you in plugin settings Terms and privacy: Depends on your configured API provider