search.ch
  1. Demande
  2. Format de la réponse
  3. Codes des status HTTP
  4. Demande d'une nouvelle clé API
  5. Conditions d'utilisation

Spécification API

Demande

Les demandes à l'interface sont envoyées par HTTP. Cela correspond au projet de REST.

Si vous obtenez une clé d'interface, vous pouvez faire plus de recherches par jour.

https://tel.search.ch/api/?was=john+meier&key=Votre clé

Une demande correcte et formelle résulte par une réponse avec statut HTTP 200. Des demandes invalides ou sans clé obtiennent une réponse avec le statut HTTP adéquat.

La lien de demande peut contenir les paramètes suivants. Toutes les valeurs doivent être encodées en URL.

ParamètreOptionnelDescription
wasnonRecherche générale par chaîne de caractères. Recherhce de noms, categories ou numéros de téléphone
woouiRestriction géografique de la recherche.
Peut contenir une rue, un lieu, un npa ou une abbréviation d'un canton.
qouiRecherche en was et wo.
privatoui1 = Recherche d'inscriptions privées, 0 = Inscriptions privées exclues. Préréglage = 1
firmaoui1 = Recherche d'inscriptions d'entreprises, 0 = Inscriptions d'entreprises exclues. Préréglage = 1
posouiPosition de la première inscription de la réponse.
Utilisez au cas où plus de résultats rendu que maxnum verwendet.
maxnumouiNombres de résultats rendu par demande.
Le nombre est limité à 200 résultats.
keyouiClé d'interface
langouiLangue. Valeurs possible: de,fr,it,en
Informations traduisible (p.ex. catégories) sont affichées dans cette language.
count_onlyoui1 = fournisse seulement le nombre de résultats (plus rapide)

Format de la réponse

Les résultats de l'interface sont rendu par un flux Atom. Le flux utilise ses propres éléments OpenSearch qui sont complétés par des espaces spécifiques pour tel.search.ch.

Les éléments OpenSearch suivants soumis directement à l'élément <feed>:

openSearch:totalResults
Nombre total d'inscriptions trouvées
openSearch:startIndex
Position de la première inscription dans le résultat. Commence par 1
openSearch:itemsPerPage
Nombre d'inscriptions affichées dans le flux. Cela correspond au paramètre maxnum.
openSearch:Query
Représentation de la recherche actuelle.
Format: <openSearch:Query role="request" searchTerms="..." startPage="1" />

Les éléments suivants sont soumis à une donnée du flux (/feed/entry) et représentent une inscription trouvée:

FeldClé interface requisDescription
/feed/entry/idneinIdentification unique selon RFC 4287
/feed/entry/publishednonDate de publication, format selon RFC 3339
Par exemple 2007-01-09T08:00:00Z
/feed/entry/updatednonDernier changement de l'inscription, format selon RFC 3339
Par exemple 2007-01-12T14:32:11Z
/feed/entry/titlenonTitre de l'inscription
Nom de la personne ou de l'entreprise
/feed/entry/contentnonRésumé des l'inscription en texte clair
/feed/entry/author/namenonAuteur de l'inscription (selon RFC 4287)
/feed/entry/link/@rel='alternate'nonLien de la page de détail sur tel.search.ch de l'inscription
/feed/entry/link/@rel='edit'nonLien de la page de correction sur tel.search.ch de l'inscription
/feed/entry/link/@type='text/x-vcard'nonLien pour le téléchargement VCard
/feed/entry/tel:posouiPosition de l'inscription du résultat complèt
/feed/entry/tel:idouiIdentifikation unique tel.search.ch de l'inscription
/feed/entry/tel:typeouiType de l'inscription: Person ou Organisation
/feed/entry/tel:orgouiOrganisation
/feed/entry/tel:nameouiNom de la personne / de l'entreprise
/feed/entry/tel:firstnameouiPrénom de la personne
/feed/entry/tel:subnamejaNom supplement
/feed/entry/tel:maidennameouiNom de jeune fille de la personne
/feed/entry/tel:occupationouiProfession de la personne, information additionelle de l'entreprise
/feed/entry/tel:categoryouiCatégorie de l'entreprise (plusieurs éléments possible)
/feed/entry/tel:streetouiNom de la rue
/feed/entry/tel:streetnoouiNuméro
/feed/entry/tel:poboxouiCase postale
/feed/entry/tel:zipouiNuméro postale
/feed/entry/tel:cityouiLieu
/feed/entry/tel:cantonouiAbréviation du canton (ZH,BE,AG,...)
/feed/entry/tel:nopromoja* ne souhaite pas de publicité
/feed/entry/tel:phoneouiNuméro de téléphone avec indicatif
/feed/entry/tel:extra/@type='fax'ouiNuméro de fax (optionnel)
/feed/entry/tel:extra/@type='email'ouiAdresse e-mail (optionnel)
/feed/entry/tel:extra/@type='website'ouiPage internet URL (optionnel)
/feed/entry/tel:extra/@type='skype'ouiNom d'utilisatuer Skype (optionnel)
/feed/entry/tel:extra/@type='icq|msn|aim|yahoo'ouiNom d'utilisateur de la messagerie instantanée (optionnel)

Un example d'une réponse en format Atom: api-response.xml

Codes des status HTTP

Chaque demande est répondu par un code status HTTP selon la spécification. Ci-dessous les codes les plus fréquents et leurs significations.

CodeDescription
200 OKSans faute
400 BAD REQUEST
401
Demande défectueuse
p.ex. paramètres manquants
403 FORBIDDENAutorisation de la clé d'interface erronée
404 NOT FOUNDPas de flux d'interface sous ce lien

En cas d'autorisation échoué une description du problème est ajouté en forme d'un flux Atom avec des paramètres approprié:

CodeDescription
/feed/tel:errorCodeCode de l'erreur
/feed/tel:errorReasonCause de l'erreur
/feed/tel:errorMessageDescription de l'erreur

Un exemple d'une réponse erronée en format Atom: api-error.xml