PHPackages                             kylekatarnls/vicopo - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kylekatarnls/vicopo

ActiveLibrary[API Development](/categories/api)

kylekatarnls/vicopo
===================

API HTTP et Script pour trouver les villes à partir d'un code postal et code postaux à partir d'une ville

1.3.0(3y ago)2833.9k—9.1%6MITJavaScriptPHP >=5.3.0

Since Feb 10Pushed 2y ago3 watchersCompare

[ Source](https://github.com/kylekatarnls/vicopo)[ Packagist](https://packagist.org/packages/kylekatarnls/vicopo)[ Docs](https://vicopo.selfbuild.fr)[ GitHub Sponsors](https://github.com/kylekatarnls)[ Fund](https://opencollective.com/Carbon)[ RSS](/packages/kylekatarnls-vicopo/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (7)Used By (0)

[VICOPO](https://vicopo.selfbuild.fr/)
======================================

[](#vicopo)

#### API HTTP et Script pour trouver les villes à partir d'un code postal et code postaux à partir d'une ville

[](#api-http-et-script-pour-trouver-les-villes-à-partir-dun-code-postal-et-code-postaux-à-partir-dune-ville)

Vicopo est un moyen léger et rapide rechercher une ville française et implémenter des propositions à la volée, l'autocomplétion d'un champ de ville ou de code postal et la conversion de l'un vers l'autre.

Utilisation
-----------

[](#utilisation)

### Afficher les villes possibles dans une liste

[](#afficher-les-villes-possibles-dans-une-liste)

```

```

Placez le code ci-dessus n'importe où sur votre page, et insérez le script après jQuery (par exemple avant ``) :

```

```

[Voir la démonstration](https://jsfiddle.net/KyleKatarn/y27x72ka/40/)

Ajoutez l'attribut data-vicopo à un élément et passez-lui en paramètre un sélecteur qui pointera vers un champ(``, `` ou ``). Quand la valeur du champs change, l'élément sera duppliqué autant de fois qu'il y a de villes commençant par la valeur tapée ou dont le code postal commence par la valeur tapée (la recherche commence à partir de 2 caractères tapés).

À l'intérieur de ces éléments, les balises portant les attributs `data-vicopo-code-postal`, `data-vicopo-ville` seront respectivement pourvus du code postal et de la ville. Si ces balises sont des champs, utilisez `data-vicopo-val-code-postal` et `data-vicopo-val-ville` pour que les informations soient assignées en tant que valeur.

Compléter le champ avec le premier nom de ville trouvé
------------------------------------------------------

[](#compléter-le-champ-avec-le-premier-nom-de-ville-trouvé)

```
$('#ville').keyup(function (e) {
  if(e.keyCode == 13) {
    var $ville = $(this);
    $.vicopo($ville.val(), function (input, cities) {
      if(input == $ville.val() && cities[0]) {
        $ville.val(cities[0].city).vicopoTargets().vicopoClean();
      }
    });
    e.preventDefault();
    e.stopPropagation();
  }
});
```

[Voir la démonstration](https://jsfiddle.net/KyleKatarn/48uuL3v5/15/)

Lors de l'appui sur `Entrée`, on récupère la première ville et on l'applique comme nouvelle valeur du champ.

L'ajout optionnel de `.vicopoTargets().vicopoClean()` permet d'effacer la liste de suggestions.

Récupérer les villes au fur et à mesure de la saisie
----------------------------------------------------

[](#récupérer-les-villes-au-fur-et-à-mesure-de-la-saisie)

```
$('#recherche').vicopo(function (cities) {
  if(cities.length) {
    $('#ville').val(cities[0].city);
    $('#code').val(cities[0].code);
  } else {
    $('#ville').val('');
    $('#code').val('');
  }
  $('#count').val(cities.length + ' villes trouvées');
});
```

Les méthodes `.vicopo()`, `.codePostal()` et `.ville()` appliquées à un élément jQuery permettent de récupérer dans une variable le résultat de la recherche à chaque lettre saisie dans le champ.

Utilisation sans champs de saisie
---------------------------------

[](#utilisation-sans-champs-de-saisie)

```
$('#cp').click(function () {
  $.ville('strasbourg', function (input, cities) {
    $('#cp-result').text(cities[0].code);
  });
});
$('#villes').click(function () {
  $.ville('des', function (input, cities) {
    $('#villes-result').text(cities.map(function (entry) {
      return entry.city;
    }).join(', '));
  });
});
```

[Voir la démonstration](https://jsfiddle.net/KyleKatarn/ny8k9ya6/16/)

Les méthodes `$.vicopo()`, `$.codePostal()` et `$.ville()` prennent en premier paramètre le code postal ou la ville (partiel ou entier) recherché et en second paramètre une fonction de callback appelée avec le terme recherché en premier paramètre, les villes trouvées en second et en troisième 'code' pour une recherche de code postal ou 'city' pour une recherche de ville.

API HTTP brute au fomart JSON (par défaut)
------------------------------------------

[](#api-http-brute-au-fomart-json-par-défaut)

ProtocoleURLHTTPHTTPS```
{
    "input": "680",
    "cities": [
        {
            "code": 68040,
            "city": "INGERSHEIM"
        },
        {
            "code": 68000,
            "city": "COLMAR"
        }
    ]
}
```

Plugin node.js
--------------

[](#plugin-nodejs)

Vicopo est disponible sous node.js directement via require('vicopo') :

```
var ville = 'Lille';
var vicopo = require('vicopo')('http');
vicopo(ville, function (err, cities) {
    if (err) {
        throw err;
    } else {
        console.log(cities);
    }
});
```

Plus d'options sur

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity38

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~473 days

Recently: every ~585 days

Total

6

Last Release

1384d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/df90c422f521bf26355c3e185a59fe7afb35531af56244dfaec03ee1d0ca6f24?d=identicon)[kylekatarn](/maintainers/kylekatarn)

---

Top Contributors

[![kylekatarnls](https://avatars.githubusercontent.com/u/5966783?v=4)](https://github.com/kylekatarnls "kylekatarnls (46 commits)")

---

Tags

apicitycodejavascriptjqueryjquery-ajaxjquery-pluginpostalville

### Embed Badge

![Health badge](/badges/kylekatarnls-vicopo/health.svg)

```
[![Health](https://phpackages.com/badges/kylekatarnls-vicopo/health.svg)](https://phpackages.com/packages/kylekatarnls-vicopo)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

265103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)